+Sun Oct 29 02:59:50 2000 Owen Taylor <otaylor@redhat.com>
+
+ * **: Updates to new gtk-doc, gsignal, causing quite
+ a bit of diffs but little real changes.
+
2000-10-24 Havoc Pennington <hp@redhat.com>
* gtk/text_widget.sgml: add note about UTF-8
## Process this file with automake to produce Makefile.in
-#SUBDIRS = gdk-pixbuf gdk gtk
+SUBDIRS = gdk-pixbuf gdk gtk
+
#GdkPixbufLoader
</para>
+<!-- ##### ENUM GdkPixbufFrameAction ##### -->
+ <para>
+ Each animation frame can have several things happen to it when the
+ next frame is displayed. The #GdkPixbufFrameAction determines
+ this. These are essentially the overlay modes supported by GIF
+ animations.
+ </para>
+
+@GDK_PIXBUF_FRAME_RETAIN: The previous image should remain displayed,
+and will potentially be occluded by the new frame.
+@GDK_PIXBUF_FRAME_DISPOSE: The animation will be reverted to the state
+before the frame was shown.
+@GDK_PIXBUF_FRAME_REVERT: The animation will be reverted to the first
+frame.
+
+<!-- ##### STRUCT GdkPixbufFrame ##### -->
+ <para>
+ This structure describes a frame in a #GdkPixbufAnimation. Each
+ frame consists of a #GdkPixbuf, an offset of the frame within the
+ animation's bounding box, a duration, and an overlay mode or
+ action.
+ </para>
+
+
+<!-- ##### STRUCT GdkPixbufAnimation ##### -->
+ <para>
+ This structure describes an animation, which is represented as a
+ list of #GdkPixbufFrame structures.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
+<para>
+
+</para>
+
+@filename:
+@error:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
+<para>
+
+</para>
+
+@animation:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
+<para>
+
+</para>
+
+@animation:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
+<para>
+
+</para>
+
+@animation:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
+<para>
+
+</para>
+
+@animation:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
+<para>
+
+</para>
+
+@animation:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
+<para>
+
+</para>
+
+@animation:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
+<para>
+
+</para>
+
+@frame:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+
gdk_pixbuf_finalize().
</para>
+<!-- ##### FUNCTION gdk_pixbuf_new ##### -->
+<para>
+
+</para>
+
+@colorspace:
+@has_alpha:
+@bits_per_sample:
+@width:
+@height:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_new_from_data ##### -->
+<para>
+
+</para>
+
+@data:
+@colorspace:
+@has_alpha:
+@bits_per_sample:
+@width:
+@height:
+@rowstride:
+@destroy_fn:
+@destroy_fn_data:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_new_from_xpm_data ##### -->
+<para>
+
+</para>
+
+@data:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_new_from_inline ##### -->
+<para>
+
+</para>
+
+@inline_pixbuf:
+@copy_pixels:
+@length:
+@error:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_copy ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+
#GdkPixbufLoader.
</para>
+<!-- ##### FUNCTION gdk_pixbuf_new_from_file ##### -->
+<para>
+
+</para>
+
+@filename:
+@error:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+
-<!-- ##### FUNCTION gdk_pixbuf_get_rowstride ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### ARG GnomeCanvasPixbuf:width_in_pixels ##### -->
+<!-- ##### USER_FUNCTION GdkPixbufLastUnref ##### -->
<para>
- If this argument is %TRUE, then the width of the pixbuf will be
- considered to be in pixels, that is, it will not be visually
- scaled even if the item's affine transformation changes. If this
- is %FALSE, then the width of the pixbuf will be considered to be
- in canvas units, and so will be scaled normally by affine
- transformations. The default is %FALSE.
+ A function of this type can be used to override the default
+ operation when a pixbuf loses its last reference, i.e. when
+ gdk_pixbuf_unref() is called on a #GdkPixbuf structure that has a
+ reference count of 1. This function should determine whether to
+ finalize the pixbuf by calling gdk_pixbuf_finalize(), or whether
+ to just resume normal execution. The last unref handler for a
+ #GdkPixbuf can be set using the
+ gdk_pixbuf_set_last_unref_handler() function. By default, pixbufs
+ will be finalized automatically if no last unref handler has been
+ defined.
</para>
+@pixbuf: The pixbuf that is losing its last reference.
+@data: User closure data.
-<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:See_Also ##### -->
- <para>
- GdkRGB
- </para>
+<!-- ##### SECTION ./tmpl/from-drawables.sgml:Title ##### -->
+Drawables to Pixbufs
-<!-- ##### FUNCTION gdk_pixbuf_load_module ##### -->
+<!-- ##### ARG GnomeCanvasPixbuf:height_pixels ##### -->
<para>
</para>
-@image_module:
-@error:
-@Returns:
-<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:See_Also ##### -->
+<!-- ##### SECTION ./tmpl/rendering.sgml:See_Also ##### -->
<para>
- #GnomeCanvas, #GdkPixbuf
+ GdkRGB
</para>
-<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Short_Description ##### -->
-
+<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Title ##### -->
+X Drawables to Pixbufs
-<!-- ##### ENUM GdkPixbufError ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_render_pixmap_and_mask ##### -->
<para>
</para>
-@GDK_PIXBUF_ERROR_CORRUPT_IMAGE:
-@GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY:
-@GDK_PIXBUF_ERROR_BAD_OPTION_VALUE:
-@GDK_PIXBUF_ERROR_UNKNOWN_TYPE:
-@GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION:
-@GDK_PIXBUF_ERROR_FAILED:
-
-<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Short_Description ##### -->
-Canvas item to display #GdkPixbuf images.
-
-
-<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Long_Description ##### -->
- <para>
- The &gdk-pixbuf; Xlib library provides several convenience
- functions to render pixbufs to X drawables. It uses XlibRGB to
- render the image data.
- </para>
+@pixbuf:
+@pixmap_return:
+@mask_return:
+@alpha_threshold: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+<!-- ##### ARG GnomeCanvasPixbuf:width ##### -->
<para>
- These functions are analogous to those for the Gdk version of
- &gdk-pixbuf;.
+ Indicates the width the pixbuf will be scaled to. This argument
+ will only be used if the <link
+ linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument
+ is %TRUE. If the <link
+ linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link>
+ argument is %FALSE, the width will be taken to be in canvas units,
+ and thus will be scaled along with the canvas item's affine
+ transformation. If width_in_pixels is %TRUE, the width will be
+ taken to be in pixels, and will visually remain a constant size
+ even if the item's affine transformation changes.
</para>
-<!-- ##### FUNCTION gdk_pixbuf_render_threshold_alpha ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable ##### -->
<para>
</para>
@pixbuf:
-@bitmap:
+@drawable:
+@gc:
@src_x:
@src_y:
@dest_x:
@dest_y:
@width:
@height:
-@alpha_threshold:
-
-<!-- ##### SECTION ./tmpl/rendering.sgml:Long_Description ##### -->
- <para>
- The &gdk-pixbuf; library provides several convenience functions to
- render pixbufs to GDK drawables. It uses the GdkRGB to render the
- image data.
- </para>
-
- <para>
- At this point there is not a standard alpha channel extension for
- the X Window System, so it is not possible to use full opacity
- information when painting images to arbitrary drawables. The
- &gdk-pixbuf; convenience functions will threshold the opacity
- information to create a bi-level clipping mask (black and white),
- and use that to draw the image onto a drawable.
- </para>
-
- <important>
- <para>
- Since these functions use GdkRGB for rendering, you must
- initialize GdkRGB before using any of them. You can do this by
- calling gdk_rgb_init() near the beginning of your program.
- </para>
- </important>
-
-
-<!-- ##### SECTION ./tmpl/xlib-init.sgml:Title ##### -->
-&gdk-pixbuf; Xlib initialization
-
+@dither:
+@x_dither:
+@y_dither:
-<!-- ##### FUNCTION gdk_pixbuf_saturate_and_pixelate ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_get_from_drawable ##### -->
<para>
</para>
-@src:
@dest:
-@saturation:
-@pixelate:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_height ##### -->
-<para>
-
-</para>
+@src:
+@cmap:
+@src_x:
+@src_y:
+@dest_x:
+@dest_y:
+@width:
+@height:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
-@pixbuf:
-@Returns:
+<!-- ##### ARG GnomeCanvasPixbuf:x ##### -->
+ <para>
+ Indicates the horizontal translation offset of the pixbuf item's
+ image. This offset may not actually appear horizontal, since it
+ will be affected by the item's affine transformation. The default
+ is 0.0.
+ </para>
-<!-- ##### FUNCTION gdk_pixbuf_get_bits_per_sample ##### -->
-<para>
-</para>
+<!-- ##### ARG GnomeCanvasPixbuf:y ##### -->
+ <para>
+ Indicates the vertical translation offset of the pixbuf item's
+ image. Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--x">x</link> argument. The default is
+ 0.0.
+ </para>
-@pixbuf:
-@Returns:
-<!-- ##### MACRO GDK_PIXBUF_MAJOR ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/xlib-init.sgml:Short_Description ##### -->
+Initializing the &gdk-pixbuf; Xlib library.
-</para>
+<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Long_Description ##### -->
+ <para>
+ The functions in this section allow you to take the image data
+ from an X drawable and dump it into a #GdkPixbuf. This can be
+ used for screenshots and other special effects. Note that these
+ operations can be expensive, since the image data has to be
+ transferred from the X server to the client program and converted.
+ </para>
-<!-- ##### ARG GnomeCanvasPixbuf:height_in_pixels ##### -->
<para>
- Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link>
- argument. The default is %FALSE.
+ These functions are analogous to those for the Gdk version of
+ &gdk-pixbuf;.
</para>
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_frames ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_new_from_art_pixbuf ##### -->
<para>
</para>
-@animation:
+@art_pixbuf:
@Returns:
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_width ##### -->
-<para>
-
-</para>
+<!-- ##### SECTION ./tmpl/xlib-init.sgml:See_Also ##### -->
+ XlibRGB
+ </para>
-@animation:
-@Returns:
-<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:See_Also ##### -->
-<para>
+<!-- ##### ARG GnomeCanvasPixbuf:y_in_pixels ##### -->
+ <para>
+ Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--x-in-pixels">x_in_pixels</link>
+ argument, but controls whether the <link
+ linkend="GnomeCanvasPixbuf--y">y</link> translation offset is
+ scaled or not. The default is %FALSE.
+ </para>
-</para>
+<!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
-<!-- ##### SECTION ./tmpl/rendering.sgml:Title ##### -->
-Rendering
+<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:See_Also ##### -->
+ <para>
+ #GnomeCanvas, #GdkPixbuf
+ </para>
-<!-- ##### MACRO GDK_PIXBUF_MINOR ##### -->
+<!-- ##### ARG GnomeCanvasPixbuf:y_pixels ##### -->
<para>
</para>
-<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Short_Description ##### -->
-Getting parts of an X drawable's image data into a pixbuf.
+<!-- ##### ARG GnomeCanvasPixbuf:pixbuf ##### -->
+ <para>
+ Contains a pointer to a #GdkPixbuf structure that will be used by
+ the pixbuf canvas item as an image source. When a pixbuf is set
+ its reference count is incremented; if the pixbuf item kept a
+ pointer to another #GdkPixbuf structure, the reference count of
+ this structure will be decremented. Also, the GdkPixbuf's
+ reference count will automatically be decremented when the
+ #GnomeCanvasPixbuf item is destroyed. When a pixbuf is queried, a
+ reference count will not be added to the return value; you must do
+ this yourself if you intend to keep the pixbuf structure around.
+ </para>
-<!-- ##### STRUCT GdkPixbufModule ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:See_Also ##### -->
+ <para>
+ GdkRGB
+ </para>
-</para>
-@module_name:
-@format_check:
-@module:
-@load:
-@load_xpm_data:
-@begin_load:
-@stop_load:
-@load_increment:
-@load_animation:
-@save:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_colorspace ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Long_Description ##### -->
+ <para>
+ The &gdk-pixbuf; Xlib library provides several convenience
+ functions to render pixbufs to X drawables. It uses XlibRGB to
+ render the image data.
+ </para>
-</para>
+ <para>
+ These functions are analogous to those for the Gdk version of
+ &gdk-pixbuf;.
+ </para>
-@pixbuf:
-@Returns:
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_num_frames ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Short_Description ##### -->
-</para>
-@animation:
-@Returns:
-<!-- ##### SECTION ./tmpl/from-drawables.sgml:Short_Description ##### -->
-Getting parts of a drawable's image data into a pixbuf.
+<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Short_Description ##### -->
+Canvas item to display #GdkPixbuf images.
-<!-- ##### FUNCTION gdk_pixbuf_render_pixmap_and_mask ##### -->
-<para>
+<!-- ##### ARG GnomeCanvasPixbuf:x_in_pixels ##### -->
+ <para>
+ If this argument is %TRUE, the pixbuf's translation with respect
+ to its logical origin in item-relative coordinates will be in
+ pixels, that is, the visible offset will not change even if the
+ item's affine transformation changes. If it is %FALSE, the
+ pixbuf's translation will be taken to be in canvas units, and thus
+ will change along with the item's affine transformation. The
+ default is %FALSE.
+ </para>
-</para>
-@pixbuf:
-@pixmap_return:
-@mask_return:
-@alpha_threshold: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
+<!-- ##### SECTION ./tmpl/from-drawables.sgml:Long_Description ##### -->
+ <para>
+ The functions in this section allow you to take the image data
+ from a GDK drawable and dump it into a #GdkPixbuf. This can be
+ used for screenshots and other special effects. Note that these
+ operations can be expensive, since the image data has to be
+ transferred from the X server to the client program and converted.
+ </para>
-<!-- ##### FUNCTION gdk_pixbuf_composite_color ##### -->
-<para>
-</para>
+<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Long_Description ##### -->
+ <para>
+ The XlibRGB set of functions is a port of the GdkRGB library to
+ use plain Xlib and X drawables. You can use these functions to
+ render RGB buffers into drawables very quickly with high-quality
+ dithering.
+ </para>
-@src:
-@dest:
-@dest_x:
-@dest_y:
-@dest_width:
-@dest_height:
-@offset_x:
-@offset_y:
-@scale_x:
-@scale_y:
-@interp_type:
-@overall_alpha:
-@check_x:
-@check_y:
-@check_size:
-@color1:
-@color2:
-
-<!-- ##### FUNCTION gdk_pixbuf_new_from_data ##### -->
-<para>
-</para>
+<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Short_Description ##### -->
+Functions for rendering RGB buffers to X drawables.
-@data:
-@colorspace:
-@has_alpha:
-@bits_per_sample:
-@width:
-@height:
-@rowstride:
-@destroy_fn:
-@destroy_fn_data:
-@Returns:
-<!-- ##### FUNCTION gdk_pixbuf_animation_new_from_file ##### -->
+<!-- ##### MACRO GNOME_CANVAS_PIXBUF ##### -->
+ <para>
+ Casts a #GtkOjbect to a #GnomeCanvasPixbuf.
+ </para>
+
+@obj: A GTK+ object.
+
+<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:See_Also ##### -->
<para>
</para>
-@filename:
-@error:
-@Returns:
-<!-- ##### ARG GnomeCanvasPixbuf:y_in_pixels ##### -->
- <para>
- Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--x-in-pixels">x_in_pixels</link>
- argument, but controls whether the <link
- linkend="GnomeCanvasPixbuf--y">y</link> translation offset is
- scaled or not. The default is %FALSE.
- </para>
+<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Short_Description ##### -->
+Rendering a pixbuf to an X drawable.
-<!--
+
+<!-- ##### FUNCTION gdk_pixbuf_finalize ##### -->
+<para>
+
+</para>
+
+@pixbuf: <!--
Local variables:
mode: sgml
sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
End:
-->
+<!-- ##### SECTION ./tmpl/rendering.sgml:Short_Description ##### -->
+Rendering a pixbuf to a GDK drawable.
+
+
+<!-- ##### FUNCTION gdk_pixbuf_set_last_unref_handler ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@last_unref_fn:
+@last_unref_fn_data:
-<!-- ##### STRUCT GdkPixbufAnimation ##### -->
+<!-- ##### ARG GnomeCanvasPixbuf:x_set ##### -->
<para>
- This structure describes an animation, which is represented as a
- list of #GdkPixbufFrame structures.
+ Determines whether the <link
+ linkend="GnomeCanvasPixbuf--x">x</link> argument is used to
+ translate the pixbuf from its logical origin in item-relative
+ coordinates.
</para>
-<!-- ##### SECTION ./tmpl/xlib-init.sgml:Short_Description ##### -->
-Initializing the &gdk-pixbuf; Xlib library.
+<!-- ##### ARG GnomeCanvasPixbuf:width_in_pixels ##### -->
+ <para>
+ If this argument is %TRUE, then the width of the pixbuf will be
+ considered to be in pixels, that is, it will not be visually
+ scaled even if the item's affine transformation changes. If this
+ is %FALSE, then the width of the pixbuf will be considered to be
+ in canvas units, and so will be scaled normally by affine
+ transformations. The default is %FALSE.
+ </para>
+
+
+<!-- ##### SECTION ./tmpl/xlib-init.sgml:Long_Description ##### -->
+ <para>
+ In addition to the normal Gdk-specific functions, the &gdk-pixbuf;
+ package provides a small library that lets Xlib-only applications
+ use #GdkPixbuf structures and render them to X drawables. The
+ functions in this section are used to initialize the &gdk-pixbuf;
+ Xlib library. This library must be initialized near the beginning
+ or the program or before calling any of the other &gdk-pixbuf;
+ Xlib functions; it cannot be initialized automatically since
+ Xlib-only applications do not call gdk_rgb_init() like GNOME
+ applications do.
+ </para>
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_delay_time ##### -->
+<!-- ##### FUNCTION gdk_pixbuf_get_format ##### -->
<para>
</para>
-@frame:
+@pixbuf:
@Returns:
-<!-- ##### ENUM GdkInterpType ##### -->
+<!-- ##### ARG GnomeCanvasPixbuf:height_in_pixels ##### -->
+ <para>
+ Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link>
+ argument. The default is %FALSE.
+ </para>
+
+
+<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:width_set ##### -->
<para>
- This enumeration describes the different interpolation modes that
- can be used with the scaling functions.
-
- <note>
- <para>
- Cubic filtering is missing from the list; hyperbolic
- interpolation is just as fast and results in higher quality.
- </para>
- </note>
+ Determines whether the <link
+ linkend="GnomeCanvasPixbuf--width">width</link> argument is taken
+ into account when scaling the pixbuf item. If this argument is
+ %FALSE, then the width value of the pixbuf will be used instead.
+ This argument is %FALSE by default.
</para>
-@GDK_INTERP_NEAREST: Nearest neighbor sampling; this is the fastest
-and lowest quality mode.
-@GDK_INTERP_TILES: This is an accurate simulation of the PostScript
-image operator without any interpolation enabled. Each pixel is
-rendered as a tiny parallelogram of solid color, the edges of which
-are implemented with antialiasing. It resembles nearest neighbor for
-enlargement, and bilinear for reduction.
-@GDK_INTERP_BILINEAR: Bilinear interpolation. For enlargement, it is
-equivalent to point-sampling the ideal bilinear-interpolated image.
-For reduction, it is equivalent to laying down small tiles and
-integrating over the coverage area.
-@GDK_INTERP_HYPER: This is the slowest and highest quality
-reconstruction function. It is derived from the hyperbolic filters in
-Wolberg's "Digital Image Warping", and is formally defined as the
-hyperbolic-filter sampling the ideal hyperbolic-filter interpolated
-image (the filter is designed to be idempotent for 1:1 pixel mapping).
<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable_alpha ##### -->
<para>
@x_dither:
@y_dither:
-<!-- ##### ENUM GdkPixbufFrameAction ##### -->
+<!-- ##### SECTION ./tmpl/xlib-init.sgml:Title ##### -->
+&gdk-pixbuf; Xlib initialization
+
+
+<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Short_Description ##### -->
+Getting parts of an X drawable's image data into a pixbuf.
+
+
+<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Title ##### -->
+XlibRGB
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:x_pixels ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG GnomeCanvasPixbuf:height ##### -->
<para>
- Each animation frame can have several things happen to it when the
- next frame is displayed. The #GdkPixbufFrameAction determines
- this. These are essentially the overlay modes supported by GIF
- animations.
+ Indicates the height the pixbuf will be scaled to. This argument
+ will only be used if the <link
+ linkend="GnomeCanvasPixbuf--height-set">height_set</link> argument
+ is %TRUE. Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--width">width</link> argument.
</para>
-@GDK_PIXBUF_FRAME_RETAIN: The previous image should remain displayed,
-and will potentially be occluded by the new frame.
-@GDK_PIXBUF_FRAME_DISPOSE: The animation will be reverted to the state
-before the frame was shown.
-@GDK_PIXBUF_FRAME_REVERT: The animation will be reverted to the first
-frame.
-<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Long_Description ##### -->
+<!-- ##### SECTION ./tmpl/from-drawables.sgml:See_Also ##### -->
<para>
- The XlibRGB set of functions is a port of the GdkRGB library to
- use plain Xlib and X drawables. You can use these functions to
- render RGB buffers into drawables very quickly with high-quality
- dithering.
+ gdk_image_get().
</para>
-<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Long_Description ##### -->
+<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GdkPixbufAnimationClass ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/rendering.sgml:Title ##### -->
+Rendering
+
+
+<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Title ##### -->
+GnomeCanvasPixbuf
+
+
+<!-- ##### MACRO GDK_PIXBUF_LOADER ##### -->
<para>
- This canvas item displays #GdkPixbuf images. It handles full
- affine transformations in both GDK and antialiased modes, and also
- supports the <ulink url="http://www.w3.org">W3C</ulink>'s <ulink
- url="http://www.w3.org/Graphics/SVG/">SVG</ulink>-like scaling and
- translation semantics for absolute pixel values.
+ Casts a #GtkObject to a #GdkPixbufLoader.
</para>
+@obj: A GTK+ object.
+
+<!-- ##### ARG GnomeCanvasPixbuf:y_set ##### -->
<para>
- #GdkPixbuf structures may be shared among different pixbuf canvas
- items; the pixbuf item uses #GdkPixbuf's reference counting
- functions for this.
+ Determines whether the <link
+ linkend="GnomeCanvasPixbuf--y">y</link> argument is used to
+ translate the pixbuf from its logical origin in item-relative
+ coordinates. Works in the same way as the <link
+ linkend="GnomeCanvasPixbuf--x-set">x_set</link> argument. The
+ default is %FALSE.
</para>
- <refsect2>
- <title>Custom Scaling and Translation</title>
- <para>
- In addition to the normal affine transformations supported by
- canvas items, the #GnomeCanvasPixbuf item supports independent
- object arguments for scaling and translation. This is useful
- for explicitly setting a size to which the pixbuf's image will
- be scaled, and for specifying translation offsets that take
- place in the item's local coordinate system.
- </para>
+<!-- ##### SECTION ./tmpl/rendering.sgml:Long_Description ##### -->
+ <para>
+ The &gdk-pixbuf; library provides several convenience functions to
+ render pixbufs to GDK drawables. It uses the GdkRGB to render the
+ image data.
+ </para>
+
+ <para>
+ At this point there is not a standard alpha channel extension for
+ the X Window System, so it is not possible to use full opacity
+ information when painting images to arbitrary drawables. The
+ &gdk-pixbuf; convenience functions will threshold the opacity
+ information to create a bi-level clipping mask (black and white),
+ and use that to draw the image onto a drawable.
+ </para>
+ <important>
<para>
- By default, the pixbuf canvas item will attain the size in units
- of the #GdkPixbuf it contains. If a #GnomeCanvasPixbuf is
- configured to use a #GdkPixbuf that has a size of 300 by 200
- pixels, then the pixbuf item will automatically obtain a size of
- 300 by 200 units in the item's local coordinate system. If the
- item is transformed with a scaling transformation of (0.5, 2.0),
- then the final image size will be of 150 by 400 pixels.
+ Since these functions use GdkRGB for rendering, you must
+ initialize GdkRGB before using any of them. You can do this by
+ calling gdk_rgb_init() near the beginning of your program.
</para>
+ </important>
- <para>
- To set custom width and height values, you must set the <link
- linkend="GnomeCanvasPixbuf--width-set">width_set</link> or <link
- linkend="GnomeCanvasPixbuf--height-set">height_set</link>
- arguments to %TRUE, and then set the <link
- linkend="GnomeCanvasPixbuf--width">width</link> or <link
- linkend="GnomeCanvasPixbuf--height">height</link> arguments to
- the desired values. The former two arguments control whether
- the latter two are used when computing the final image's size;
+
+<!-- ##### SECTION ./tmpl/from-drawables.sgml:Short_Description ##### -->
+Getting parts of a drawable's image data into a pixbuf.
+
+
+<!-- ##### FUNCTION gdk_pixbuf_render_threshold_alpha ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@bitmap:
+@src_x:
+@src_y:
+@dest_x:
+@dest_y:
+@width:
+@height:
+@alpha_threshold:
+
+<!-- ##### ARG GnomeCanvasPixbuf:width_pixels ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### STRUCT GdkPixbufClass ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Long_Description ##### -->
+ <para>
+ This canvas item displays #GdkPixbuf images. It handles full
+ affine transformations in both GDK and antialiased modes, and also
+ supports the <ulink url="http://www.w3.org">W3C</ulink>'s <ulink
+ url="http://www.w3.org/Graphics/SVG/">SVG</ulink>-like scaling and
+ translation semantics for absolute pixel values.
+ </para>
+
+ <para>
+ #GdkPixbuf structures may be shared among different pixbuf canvas
+ items; the pixbuf item uses #GdkPixbuf's reference counting
+ functions for this.
+ </para>
+
+ <refsect2>
+ <title>Custom Scaling and Translation</title>
+
+ <para>
+ In addition to the normal affine transformations supported by
+ canvas items, the #GnomeCanvasPixbuf item supports independent
+ object arguments for scaling and translation. This is useful
+ for explicitly setting a size to which the pixbuf's image will
+ be scaled, and for specifying translation offsets that take
+ place in the item's local coordinate system.
+ </para>
+
+ <para>
+ By default, the pixbuf canvas item will attain the size in units
+ of the #GdkPixbuf it contains. If a #GnomeCanvasPixbuf is
+ configured to use a #GdkPixbuf that has a size of 300 by 200
+ pixels, then the pixbuf item will automatically obtain a size of
+ 300 by 200 units in the item's local coordinate system. If the
+ item is transformed with a scaling transformation of (0.5, 2.0),
+ then the final image size will be of 150 by 400 pixels.
+ </para>
+
+ <para>
+ To set custom width and height values, you must set the <link
+ linkend="GnomeCanvasPixbuf--width-set">width_set</link> or <link
+ linkend="GnomeCanvasPixbuf--height-set">height_set</link>
+ arguments to %TRUE, and then set the <link
+ linkend="GnomeCanvasPixbuf--width">width</link> or <link
+ linkend="GnomeCanvasPixbuf--height">height</link> arguments to
+ the desired values. The former two arguments control whether
+ the latter two are used when computing the final image's size;
they are both %FALSE by default so that the pixbuf item will
attain a size in units equal to the size in pixels of the
#GdkPixbuf that the item contains.
</refsect2>
-<!-- ##### SECTION ./tmpl/rendering.sgml:Short_Description ##### -->
-Rendering a pixbuf to a GDK drawable.
-
-
-<!-- ##### MACRO GDK_PIXBUF_LOADER ##### -->
- <para>
- Casts a #GtkObject to a #GdkPixbufLoader.
- </para>
-
-@obj: A GTK+ object.
-
-<!-- ##### STRUCT GdkPixbufAnimationClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:x_set ##### -->
- <para>
- Determines whether the <link
- linkend="GnomeCanvasPixbuf--x">x</link> argument is used to
- translate the pixbuf from its logical origin in item-relative
- coordinates.
- </para>
-
-
-<!-- ##### USER_FUNCTION ModulePreparedNotifyFunc ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@user_data:
-
-<!-- ##### MACRO GNOME_CANVAS_PIXBUF ##### -->
- <para>
- Casts a #GtkOjbect to a #GnomeCanvasPixbuf.
- </para>
-
-@obj: A GTK+ object.
-
-<!-- ##### FUNCTION gdk_pixbuf_ref ##### -->
- <para>
-
- </para>
-
-@pixbuf:
-@Returns:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_width ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-<!-- ##### ENUM GdkColorspace ##### -->
- <para>
- This enumeration defines the color spaces that are supported by
- the &gdk-pixbuf; library. Currently only RGB is supported.
- </para>
+<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Title ##### -->
+Xlib Rendering
-@GDK_COLORSPACE_RGB: Indicates a red/green/blue additive color space.
-<!-- ##### ARG GnomeCanvasPixbuf:width_set ##### -->
+<!-- ##### ARG GnomeCanvasPixbuf:height_set ##### -->
<para>
Determines whether the <link
- linkend="GnomeCanvasPixbuf--width">width</link> argument is taken
- into account when scaling the pixbuf item. If this argument is
- %FALSE, then the width value of the pixbuf will be used instead.
- This argument is %FALSE by default.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_module ##### -->
-<para>
-
-</para>
-
-@buffer:
-@size:
-@filename:
-@error:
-@Returns:
-
-<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Long_Description ##### -->
- <para>
- The functions in this section allow you to take the image data
- from an X drawable and dump it into a #GdkPixbuf. This can be
- used for screenshots and other special effects. Note that these
- operations can be expensive, since the image data has to be
- transferred from the X server to the client program and converted.
- </para>
-
- <para>
- These functions are analogous to those for the Gdk version of
- &gdk-pixbuf;.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_get_named_module ##### -->
-<para>
-
-</para>
-
-@name:
-@error:
-@Returns:
-
-<!-- ##### FUNCTION gdk_pixbuf_new ##### -->
-<para>
-
-</para>
-
-@colorspace:
-@has_alpha:
-@bits_per_sample:
-@width:
-@height:
-@Returns:
-
-<!-- ##### USER_FUNCTION GdkPixbufLastUnref ##### -->
- <para>
- A function of this type can be used to override the default
- operation when a pixbuf loses its last reference, i.e. when
- gdk_pixbuf_unref() is called on a #GdkPixbuf structure that has a
- reference count of 1. This function should determine whether to
- finalize the pixbuf by calling gdk_pixbuf_finalize(), or whether
- to just resume normal execution. The last unref handler for a
- #GdkPixbuf can be set using the
- gdk_pixbuf_set_last_unref_handler() function. By default, pixbufs
- will be finalized automatically if no last unref handler has been
- defined.
- </para>
-
-@pixbuf: The pixbuf that is losing its last reference.
-@data: User closure data.
-
-<!-- ##### FUNCTION gdk_pixbuf_new_from_inline ##### -->
-<para>
-
-</para>
-
-@inline_pixbuf:
-@copy_pixels:
-@length:
-@error:
-@Returns:
-
-<!-- ##### SECTION ./tmpl/xlib-init.sgml:See_Also ##### -->
- <para>
- XlibRGB
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_unref ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_has_alpha ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### USER_FUNCTION GdkPixbufDestroyNotify ##### -->
- <para>
- A function of this type is responsible for freeing the pixel array
- of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
- pass in a pre-allocated pixel array so that a pixbuf can be
- created from it; in this case you will need to pass in a function
- of #GdkPixbufDestroyNotify so that the pixel data can be freed
- when the pixbuf is finalized.
+ linkend="GnomeCanvasPixbuf--height">height</link> argument is
+ taken into account when scaling the pixbuf item. Works in the
+ same way as the <link
+ linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument.
+ The default is %FALSE.
</para>
-@pixels: The pixel array of the pixbuf that is being finalized.
-@data: User closure data.
-
-<!-- ##### MACRO GDK_PIXBUF_ERROR ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_new_from_xpm_data ##### -->
-<para>
-
-</para>
-
-@data:
-@Returns:
-<!-- ##### FUNCTION gdk_pixbuf_new_from_art_pixbuf ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Title ##### -->
+gdk-pixbuf-io
-</para>
-
-@art_pixbuf:
-@Returns:
-
-<!-- ##### FUNCTION gdk_pixbuf_scale_simple ##### -->
-<para>
-
-</para>
-
-@src:
-@dest_width:
-@dest_height:
-@interp_type:
-@Returns:
-
-<!-- ##### ARG GnomeCanvasPixbuf:height ##### -->
- <para>
- Indicates the height the pixbuf will be scaled to. This argument
- will only be used if the <link
- linkend="GnomeCanvasPixbuf--height-set">height_set</link> argument
- is %TRUE. Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--width">width</link> argument.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_composite ##### -->
-<para>
-
-</para>
-
-@src:
-@dest:
-@dest_x:
-@dest_y:
-@dest_width:
-@dest_height:
-@offset_x:
-@offset_y:
-@scale_x:
-@scale_y:
-@interp_type:
-@overall_alpha:
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_pixbuf ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_n_channels ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Title ##### -->
-Xlib Rendering
-
-
-<!-- ##### SECTION ./tmpl/from-drawables.sgml:See_Also ##### -->
- <para>
- gdk_image_get().
- </para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:height_pixels ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:pixbuf ##### -->
- <para>
- Contains a pointer to a #GdkPixbuf structure that will be used by
- the pixbuf canvas item as an image source. When a pixbuf is set
- its reference count is incremented; if the pixbuf item kept a
- pointer to another #GdkPixbuf structure, the reference count of
- this structure will be decremented. Also, the GdkPixbuf's
- reference count will automatically be decremented when the
- #GnomeCanvasPixbuf item is destroyed. When a pixbuf is queried, a
- reference count will not be added to the return value; you must do
- this yourself if you intend to keep the pixbuf structure around.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_action ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns:
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_y_offset ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns:
-
-<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Short_Description ##### -->
-Functions for rendering RGB buffers to X drawables.
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:x ##### -->
- <para>
- Indicates the horizontal translation offset of the pixbuf item's
- image. This offset may not actually appear horizontal, since it
- will be affected by the item's affine transformation. The default
- is 0.0.
- </para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:y ##### -->
- <para>
- Indicates the vertical translation offset of the pixbuf item's
- image. Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--x">x</link> argument. The default is
- 0.0.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_get_height ##### -->
-<para>
-
-</para>
-
-@animation:
-@Returns:
-
-<!-- ##### ARG GnomeCanvasPixbuf:width ##### -->
- <para>
- Indicates the width the pixbuf will be scaled to. This argument
- will only be used if the <link
- linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument
- is %TRUE. If the <link
- linkend="GnomeCanvasPixbuf--width-in-pixels">width_in_pixels</link>
- argument is %FALSE, the width will be taken to be in canvas units,
- and thus will be scaled along with the canvas item's affine
- transformation. If width_in_pixels is %TRUE, the width will be
- taken to be in pixels, and will visually remain a constant size
- even if the item's affine transformation changes.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_composite_color_simple ##### -->
-<para>
-
-</para>
-
-@src:
-@dest_width:
-@dest_height:
-@interp_type:
-@overall_alpha:
-@check_size:
-@color1:
-@color2:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### MACRO GDK_PIXBUF_MICRO ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_preinit ##### -->
-<para>
-
-</para>
-
-@app:
-@modinfo:
-
-<!-- ##### FUNCTION gdk_pixbuf_set_last_unref_handler ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@last_unref_fn:
-@last_unref_fn_data:
-
-<!-- ##### ARG GnomeCanvasPixbuf:height_set ##### -->
- <para>
- Determines whether the <link
- linkend="GnomeCanvasPixbuf--height">height</link> argument is
- taken into account when scaling the pixbuf item. Works in the
- same way as the <link
- linkend="GnomeCanvasPixbuf--width-set">width_set</link> argument.
- The default is %FALSE.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_unref ##### -->
-<para>
-
-</para>
-
-@animation:
-
-<!-- ##### FUNCTION gdk_pixbuf_render_to_drawable ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@drawable:
-@gc:
-@src_x:
-@src_y:
-@dest_x:
-@dest_y:
-@width:
-@height:
-@dither:
-@x_dither:
-@y_dither:
-
-<!-- ##### SECTION ./tmpl/xlib-init.sgml:Long_Description ##### -->
- <para>
- In addition to the normal Gdk-specific functions, the &gdk-pixbuf;
- package provides a small library that lets Xlib-only applications
- use #GdkPixbuf structures and render them to X drawables. The
- functions in this section are used to initialize the &gdk-pixbuf;
- Xlib library. This library must be initialized near the beginning
- or the program or before calling any of the other &gdk-pixbuf;
- Xlib functions; it cannot be initialized automatically since
- Xlib-only applications do not call gdk_rgb_init() like GNOME
- applications do.
- </para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:y_pixels ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:See_Also ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_frame_get_x_offset ##### -->
-<para>
-
-</para>
-
-@frame:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Long_Description ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/rendering.sgml:See_Also ##### -->
- <para>
- GdkRGB
- </para>
-
-
-<!-- ##### SECTION ./tmpl/xlib-rendering.sgml:Short_Description ##### -->
-Rendering a pixbuf to an X drawable.
-
-
-<!-- ##### USER_FUNCTION ModuleUpdatedNotifyFunc ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@x:
-@y:
-@width:
-@height:
-@user_data:
-
-<!-- ##### FUNCTION gdk_pixbuf_finalize ##### -->
-<para>
-
-</para>
-
-@pixbuf: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### FUNCTION gdk_pixbuf_get_pixels ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_from_drawable ##### -->
-<para>
-
-</para>
-
-@dest:
-@src:
-@cmap:
-@src_x:
-@src_y:
-@dest_x:
-@dest_y:
-@width:
-@height:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### USER_FUNCTION ModuleFrameDoneNotifyFunc ##### -->
-<para>
-
-</para>
-
-@frame:
-@user_data:
-
-<!-- ##### FUNCTION gdk_pixbuf_postinit ##### -->
-<para>
-
-</para>
-
-@app:
-@modinfo:
-
-<!-- ##### SECTION ./tmpl/gdk-pixbuf-io.sgml:Title ##### -->
-gdk-pixbuf-io
-
-
-<!-- ##### FUNCTION gdk_pixbuf_copy ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### ARG GnomeCanvasPixbuf:y_set ##### -->
- <para>
- Determines whether the <link
- linkend="GnomeCanvasPixbuf--y">y</link> argument is used to
- translate the pixbuf from its logical origin in item-relative
- coordinates. Works in the same way as the <link
- linkend="GnomeCanvasPixbuf--x-set">x_set</link> argument. The
- default is %FALSE.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_animation_ref ##### -->
-<para>
-
-</para>
-
-@animation:
-@Returns:
-
-<!-- ##### SECTION ./tmpl/gnome-canvas-pixbuf.sgml:Title ##### -->
-GnomeCanvasPixbuf
-
-
-<!-- ##### STRUCT GdkPixbuf ##### -->
- <para>
- This is the main structure in the &gdk-pixbuf; library. It is
- used to represent images. It contains information about the
- image's pixel data, its color space, bits per sample, width and
- height, and the rowstride or number of bytes between rows.
- </para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:x_pixels ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### MACRO GDK_PIXBUF_VERSION ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### VARIABLE gdk_pixbuf_version ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_scale ##### -->
-<para>
-
-</para>
-
-@src:
-@dest:
-@dest_x:
-@dest_y:
-@dest_width:
-@dest_height:
-@offset_x:
-@offset_y:
-@scale_x:
-@scale_y:
-@interp_type:
-
-<!-- ##### FUNCTION gdk_pixbuf_get_format ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@Returns:
-
-<!-- ##### SECTION ./tmpl/from-drawables.sgml:Long_Description ##### -->
- <para>
- The functions in this section allow you to take the image data
- from a GDK drawable and dump it into a #GdkPixbuf. This can be
- used for screenshots and other special effects. Note that these
- operations can be expensive, since the image data has to be
- transferred from the X server to the client program and converted.
- </para>
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:width_pixels ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
- <para>
- These values can be passed to
- gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
- chanel of an image should be handled. This function can create a
- bilevel clipping mask (black and white) and use it while painting
- the image. In the future, when the X Window System gets an alpha
- channel extension, it will be possible to do full alpha
- compositing onto arbitrary drawables. For now both cases fall
- back to a bilevel clipping mask.
- </para>
-
-@GDK_PIXBUF_ALPHA_BILEVEL: A bilevel clipping mask (black and white)
-will be created and used to draw the image. Pixels below 0.5 opacity
-will be considered fully transparent, and all others will be
-considered fully opaque.
-@GDK_PIXBUF_ALPHA_FULL: For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
-In the future it will do full alpha compositing.
-
-<!-- ##### STRUCT GdkPixbufFrame ##### -->
- <para>
- This structure describes a frame in a #GdkPixbufAnimation. Each
- frame consists of a #GdkPixbuf, an offset of the frame within the
- animation's bounding box, a duration, and an overlay mode or
- action.
- </para>
-
-
-<!-- ##### FUNCTION gdk_pixbuf_add_alpha ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@substitute_color:
-@r:
-@g:
-@b:
-@Returns:
-
-<!-- ##### USER_FUNCTION ModuleAnimationDoneNotifyFunc ##### -->
-<para>
-
-</para>
-
-@pixbuf:
-@user_data:
-
-<!-- ##### FUNCTION gdk_pixbuf_copy_area ##### -->
-<para>
-
-</para>
-
-@src_pixbuf:
-@src_x:
-@src_y:
-@width:
-@height:
-@dest_pixbuf:
-@dest_x:
-@dest_y: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
-
-<!-- ##### FUNCTION gdk_pixbuf_init ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/xlib-from-drawables.sgml:Title ##### -->
-X Drawables to Pixbufs
-
-
-<!-- ##### STRUCT GdkPixbufClass ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### SECTION ./tmpl/from-drawables.sgml:Title ##### -->
-Drawables to Pixbufs
-
-
-<!-- ##### ARG GnomeCanvasPixbuf:x_in_pixels ##### -->
- <para>
- If this argument is %TRUE, the pixbuf's translation with respect
- to its logical origin in item-relative coordinates will be in
- pixels, that is, the visible offset will not change even if the
- item's affine transformation changes. If it is %FALSE, the
- pixbuf's translation will be taken to be in canvas units, and thus
- will change along with the item's affine transformation. The
- default is %FALSE.
- </para>
-
-
-<!-- ##### SECTION ./tmpl/xlib-rgb.sgml:Title ##### -->
-XlibRGB
-
-
-<!-- ##### FUNCTION gdk_pixbuf_new_from_file ##### -->
-<para>
-
-</para>
-
-@filename:
-@error:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
-End:
--->
<para>
</para>
+<!-- ##### ENUM GdkPixbufError ##### -->
+<para>
+
+</para>
+
+@GDK_PIXBUF_ERROR_CORRUPT_IMAGE:
+@GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY:
+@GDK_PIXBUF_ERROR_BAD_OPTION_VALUE:
+@GDK_PIXBUF_ERROR_UNKNOWN_TYPE:
+@GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION:
+@GDK_PIXBUF_ERROR_FAILED:
+
+<!-- ##### MACRO GDK_PIXBUF_ERROR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### ENUM GdkColorspace ##### -->
+ <para>
+ This enumeration defines the color spaces that are supported by
+ the &gdk-pixbuf; library. Currently only RGB is supported.
+ </para>
+
+@GDK_COLORSPACE_RGB: Indicates a red/green/blue additive color space.
+
+<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
+ <para>
+ These values can be passed to
+ gdk_pixbuf_render_to_drawable_alpha() to control how the alpha
+ chanel of an image should be handled. This function can create a
+ bilevel clipping mask (black and white) and use it while painting
+ the image. In the future, when the X Window System gets an alpha
+ channel extension, it will be possible to do full alpha
+ compositing onto arbitrary drawables. For now both cases fall
+ back to a bilevel clipping mask.
+ </para>
+
+@GDK_PIXBUF_ALPHA_BILEVEL: A bilevel clipping mask (black and white)
+will be created and used to draw the image. Pixels below 0.5 opacity
+will be considered fully transparent, and all others will be
+considered fully opaque.
+@GDK_PIXBUF_ALPHA_FULL: For now falls back to #GDK_PIXBUF_ALPHA_BILEVEL.
+In the future it will do full alpha compositing.
+
+<!-- ##### STRUCT GdkPixbuf ##### -->
+ <para>
+ This is the main structure in the &gdk-pixbuf; library. It is
+ used to represent images. It contains information about the
+ image's pixel data, its color space, bits per sample, width and
+ height, and the rowstride or number of bytes between rows.
+ </para>
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_colorspace ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_n_channels ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_has_alpha ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_bits_per_sample ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_pixels ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_width ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_height ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_rowstride ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+
</para>
+<!-- ##### FUNCTION gdk_pixbuf_init ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gdk_pixbuf_preinit ##### -->
+<para>
+
+</para>
+
+@app:
+@modinfo:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_postinit ##### -->
+<para>
+
+</para>
+
+@app:
+@modinfo:
+
+
+<!-- ##### VARIABLE gdk_pixbuf_version ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### MACRO GDK_PIXBUF_VERSION ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GDK_PIXBUF_MAJOR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GDK_PIXBUF_MINOR ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO GDK_PIXBUF_MICRO ##### -->
+<para>
+
+</para>
+
+
+
</para>
+<!-- ##### USER_FUNCTION ModulePreparedNotifyFunc ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@user_data:
+
+
+<!-- ##### USER_FUNCTION ModuleUpdatedNotifyFunc ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@x:
+@y:
+@width:
+@height:
+@user_data:
+
+
+<!-- ##### USER_FUNCTION ModuleFrameDoneNotifyFunc ##### -->
+<para>
+
+</para>
+
+@frame:
+@user_data:
+
+
+<!-- ##### USER_FUNCTION ModuleAnimationDoneNotifyFunc ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@user_data:
+
+
+<!-- ##### STRUCT GdkPixbufModule ##### -->
+<para>
+
+</para>
+
+@module_name:
+@format_check:
+@module:
+@load:
+@load_xpm_data:
+@begin_load:
+@stop_load:
+@load_increment:
+@load_animation:
+@save:
+
+<!-- ##### FUNCTION gdk_pixbuf_get_module ##### -->
+<para>
+
+</para>
+
+@buffer:
+@size:
+@filename:
+@error:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_get_named_module ##### -->
+<para>
+
+</para>
+
+@name:
+@error:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_load_module ##### -->
+<para>
+
+</para>
+
+@image_module:
+@error:
+@Returns:
+
+
#GdkPixbuf, gdk_pixbuf_new_from_data().
</para>
+<!-- ##### USER_FUNCTION GdkPixbufDestroyNotify ##### -->
+ <para>
+ A function of this type is responsible for freeing the pixel array
+ of a pixbuf. The gdk_pixbuf_new_from_data() function lets you
+ pass in a pre-allocated pixel array so that a pixbuf can be
+ created from it; in this case you will need to pass in a function
+ of #GdkPixbufDestroyNotify so that the pixel data can be freed
+ when the pixbuf is finalized.
+ </para>
+
+@pixels: The pixel array of the pixbuf that is being finalized.
+@data: User closure data.
+
+
+<!-- ##### FUNCTION gdk_pixbuf_ref ##### -->
+ <para>
+
+ </para>
+
+@pixbuf:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_unref ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+
+
GdkRGB
</para>
+<!-- ##### ENUM GdkInterpType ##### -->
+ <para>
+ This enumeration describes the different interpolation modes that
+ can be used with the scaling functions.
+
+ <note>
+ <para>
+ Cubic filtering is missing from the list; hyperbolic
+ interpolation is just as fast and results in higher quality.
+ </para>
+ </note>
+ </para>
+
+@GDK_INTERP_NEAREST: Nearest neighbor sampling; this is the fastest
+and lowest quality mode.
+@GDK_INTERP_TILES: This is an accurate simulation of the PostScript
+image operator without any interpolation enabled. Each pixel is
+rendered as a tiny parallelogram of solid color, the edges of which
+are implemented with antialiasing. It resembles nearest neighbor for
+enlargement, and bilinear for reduction.
+@GDK_INTERP_BILINEAR: Bilinear interpolation. For enlargement, it is
+equivalent to point-sampling the ideal bilinear-interpolated image.
+For reduction, it is equivalent to laying down small tiles and
+integrating over the coverage area.
+@GDK_INTERP_HYPER: This is the slowest and highest quality
+reconstruction function. It is derived from the hyperbolic filters in
+Wolberg's "Digital Image Warping", and is formally defined as the
+hyperbolic-filter sampling the ideal hyperbolic-filter interpolated
+image (the filter is designed to be idempotent for 1:1 pixel mapping).
+
+<!-- ##### FUNCTION gdk_pixbuf_scale ##### -->
+<para>
+
+</para>
+
+@src:
+@dest:
+@dest_x:
+@dest_y:
+@dest_width:
+@dest_height:
+@offset_x:
+@offset_y:
+@scale_x:
+@scale_y:
+@interp_type:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_composite ##### -->
+<para>
+
+</para>
+
+@src:
+@dest:
+@dest_x:
+@dest_y:
+@dest_width:
+@dest_height:
+@offset_x:
+@offset_y:
+@scale_x:
+@scale_y:
+@interp_type:
+@overall_alpha:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_composite_color ##### -->
+<para>
+
+</para>
+
+@src:
+@dest:
+@dest_x:
+@dest_y:
+@dest_width:
+@dest_height:
+@offset_x:
+@offset_y:
+@scale_x:
+@scale_y:
+@interp_type:
+@overall_alpha:
+@check_x:
+@check_y:
+@check_size:
+@color1:
+@color2:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_scale_simple ##### -->
+<para>
+
+</para>
+
+@src:
+@dest_width:
+@dest_height:
+@interp_type:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_composite_color_simple ##### -->
+<para>
+
+</para>
+
+@src:
+@dest_width:
+@dest_height:
+@interp_type:
+@overall_alpha:
+@check_size:
+@color1:
+@color2:
+@Returns: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+
#GdkPixbuf
</para>
+<!-- ##### FUNCTION gdk_pixbuf_add_alpha ##### -->
+<para>
+
+</para>
+
+@pixbuf:
+@substitute_color:
+@r:
+@g:
+@b:
+@Returns:
+
+
+<!-- ##### FUNCTION gdk_pixbuf_copy_area ##### -->
+<para>
+
+</para>
+
+@src_pixbuf:
+@src_x:
+@src_y:
+@width:
+@height:
+@dest_pixbuf:
+@dest_x:
+@dest_y: <!--
+Local variables:
+mode: sgml
+sgml-parent-document: ("../gdk-pixbuf.sgml" "book" "refsect2" "")
+End:
+-->
+
+
+<!-- ##### FUNCTION gdk_pixbuf_saturate_and_pixelate ##### -->
+<para>
+
+</para>
+
+@src:
+@dest:
+@saturation:
+@pixelate:
+
+
-<!-- ##### FUNCTION gdk_input_set_mode ##### -->
+<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
<para>
-Enables or disables a device, and determines how the
-device maps onto the screen.
-</para>
-@deviceid: the device to configure.
-@mode: the new mode.
-@Returns: %TRUE if the device supports the given mode, otherwise
- %FALSE and the device's mode is unchanged.
-
-<!-- ##### FUNCTION gdk_input_set_key ##### -->
-<para>
-Sets the key event generated when a macro button is pressed.
</para>
-@deviceid: the device to configure.
-@index: the index of the macro button.
-@keyval: the key value for the #GdkKeypressEvent to generate.
- (a value of 0 means no event will be generated.)
-@modifiers: the modifier field for the generated
- #GdkKeyPressEvent.
-
-<!-- ##### FUNCTION gdk_regions_intersect ##### -->
-<para>
-Returns the intersection of two regions.
-</para>
-
-@source1: a #GdkRegion.
-@source2: a #GdkRegion.
-@Returns: the intersection of @source1 and @source2.
<!-- ##### FUNCTION gdk_regions_xor ##### -->
<para>
@Returns: the difference between the union and the intersection of @source1
and @source2.
-<!-- ##### FUNCTION gdk_regions_subtract ##### -->
-<para>
-Subtracts one region from another.
-The result is a region containing all the pixels which are in @source1, but
-which are not in @source2.
-</para>
-
-@source1: a #GdkRegion.
-@source2: a #GdkRegion to subtract from @source1.
-@Returns: @source1 - @source2.
-
-<!-- ##### FUNCTION gdk_input_list_devices ##### -->
+<!-- ##### FUNCTION gdk_input_motion_events ##### -->
<para>
-Lists all available input devices, along with their
-configuration information.
+Retrieves the motion history for a given device/window pair.
</para>
-@Returns: A #GList of #GdkDeviceInfo structures. This list
- is internal data of GTK+ and should not be modified
- or freed.
-
-<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
-
-
+@window: a #GdkWindow.
+@deviceid: the device for which to retrieve motion history.
+@start: the start time.
+@stop: the stop time.
+@nevents_return: location to store the number of events returned.
+@Returns: a newly allocated array containing all the events
+ from @start to @stop. This array should be freed
+ with g_free() when you are finished using it.
-<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
+<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
<para>
</para>
-<!-- ##### MACRO GDK_CORE_POINTER ##### -->
-<para>
-This macro contains an integer value representing
-the device ID for the core pointer device.
-</para>
-
-
-<!-- ##### VARIABLE gdk_threads_mutex ##### -->
-<para>
-
-</para>
-
-
-<!-- ##### FUNCTION gdk_input_set_axes ##### -->
-<para>
-Sets the mapping of the axes (valuators) of a device
-onto the predefined valuator types that GTK+ understands.
-</para>
-
-@deviceid: the device to configure.
-@axes: an array of GdkAxisUse. This length of this array
- must match the number of axes for the device.
-
<!-- ##### STRUCT GdkDeviceInfo ##### -->
<para>
The #GdkDeviceInfo structure contains information about a
which describe what key press events are generated
for each macro button.
-<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
-Points, Rectangles and Regions
+<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
+Pango Interaction
-<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
+<!-- ##### FUNCTION gdk_regions_union ##### -->
<para>
-
+Returns the union of two regions.
+This is all pixels in either of @source1 or @source2.
</para>
+@source1: a #GdkRegion.
+@source2: a #GdkRegion.
+@Returns: the union of @source1 and @source2.
-<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
-<para>
+<!-- ##### SECTION ./tmpl/gdkregion.sgml:Short_Description ##### -->
-</para>
-@GDK_PIXBUF_ALPHA_BILEVEL:
-@GDK_PIXBUF_ALPHA_FULL:
-<!-- ##### FUNCTION gdk_input_motion_events ##### -->
+<!-- ##### FUNCTION gdk_input_set_key ##### -->
<para>
-Retrieves the motion history for a given device/window pair.
+Sets the key event generated when a macro button is pressed.
</para>
-@window: a #GdkWindow.
-@deviceid: the device for which to retrieve motion history.
-@start: the start time.
-@stop: the stop time.
-@nevents_return: location to store the number of events returned.
-@Returns: a newly allocated array containing all the events
- from @start to @stop. This array should be freed
- with g_free() when you are finished using it.
+@deviceid: the device to configure.
+@index: the index of the macro button.
+@keyval: the key value for the #GdkKeypressEvent to generate.
+ (a value of 0 means no event will be generated.)
+@modifiers: the modifier field for the generated
+ #GdkKeyPressEvent.
-<!-- ##### VARIABLE gdk_core_pointer ##### -->
+<!-- ##### FUNCTION gdk_input_list_devices ##### -->
<para>
-
+Lists all available input devices, along with their
+configuration information.
</para>
+@Returns: A #GList of #GdkDeviceInfo structures. This list
+ is internal data of GTK+ and should not be modified
+ or freed.
-<!-- ##### SECTION ./tmpl/gdkregion.sgml:See_Also ##### -->
+<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:See_Also ##### -->
<para>
</para>
-<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Title ##### -->
-Pango Interaction
-
-
-<!-- ##### SECTION ./tmpl/gdkregion.sgml:Long_Description ##### -->
+<!-- ##### ENUM GdkPixbufAlphaMode ##### -->
<para>
</para>
+@GDK_PIXBUF_ALPHA_BILEVEL:
+@GDK_PIXBUF_ALPHA_FULL:
-<!-- ##### FUNCTION gdk_regions_union ##### -->
+<!-- ##### FUNCTION gdk_regions_subtract ##### -->
<para>
-Returns the union of two regions.
-This is all pixels in either of @source1 or @source2.
+Subtracts one region from another.
+The result is a region containing all the pixels which are in @source1, but
+which are not in @source2.
</para>
@source1: a #GdkRegion.
-@source2: a #GdkRegion.
-@Returns: the union of @source1 and @source2.
+@source2: a #GdkRegion to subtract from @source1.
+@Returns: @source1 - @source2.
<!-- ##### FUNCTION gdk_input_window_get_pointer ##### -->
<para>
@ytilt: location to store current tilt in the y direction.
@mask: location to store the current modifier state.
+<!-- ##### MACRO GDK_CORE_POINTER ##### -->
+<para>
+This macro contains an integer value representing
+the device ID for the core pointer device.
+</para>
+
+
+<!-- ##### FUNCTION gdk_input_set_axes ##### -->
+<para>
+Sets the mapping of the axes (valuators) of a device
+onto the predefined valuator types that GTK+ understands.
+</para>
+
+@deviceid: the device to configure.
+@axes: an array of GdkAxisUse. This length of this array
+ must match the number of axes for the device.
+
<!-- ##### FUNCTION gdk_input_set_source ##### -->
<para>
Sets the source type for a device.
@deviceid: the device to configure
@source: the new source type.
+<!-- ##### SECTION ./tmpl/gdkregion.sgml:Title ##### -->
+Points, Rectangles and Regions
+
+
+<!-- ##### FUNCTION gdk_regions_intersect ##### -->
+<para>
+Returns the intersection of two regions.
+</para>
+
+@source1: a #GdkRegion.
+@source2: a #GdkRegion.
+@Returns: the intersection of @source1 and @source2.
+
+<!-- ##### FUNCTION gdk_input_set_mode ##### -->
+<para>
+Enables or disables a device, and determines how the
+device maps onto the screen.
+</para>
+
+@deviceid: the device to configure.
+@mode: the new mode.
+@Returns: %TRUE if the device supports the given mode, otherwise
+ %FALSE and the device's mode is unchanged.
+
+<!-- ##### SECTION ./tmpl/input_methods.sgml.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
@Returns:
+<!-- ##### VARIABLE gdk_core_pointer ##### -->
+<para>
+
+</para>
+
+
<!-- ##### FUNCTION gdk_device_set_source ##### -->
<para>
+<!-- ##### VARIABLE gdk_threads_mutex ##### -->
+<para>
+
+</para>
+
+
gtkhsv.h \
gtkimcontextsimple.h \
gtkintl.h \
+ gtkmarshal.h \
gtkprivate.h \
gtktextbtree.h \
gtktextchild.h \
gtk_text_buffer_get_tags
gtk_text_buffer_modified
gtk_text_buffer_set_modified
-gtk_text_buffer_set_clipboard_contents
-gtk_text_buffer_get_clipboard_contents
-gtk_text_buffer_paste_primary_selection
gtk_text_buffer_delete_selection
-gtk_text_buffer_cut
-gtk_text_buffer_copy
gtk_text_buffer_paste_clipboard
gtk_text_buffer_get_selection_bounds
<SUBSECTION Standard>
GtkTextMark
gtk_text_mark_set_visible
gtk_text_mark_is_visible
-gtk_text_mark_ref
-gtk_text_mark_unref
gtk_text_mark_get_deleted
</SECTION>
GtkTextTag
GtkTextBTreeNode
GtkTextTagTable
-GtkTextTabArray
GtkWrapMode
GtkTextAttributes
<TITLE>GtkTextTag</TITLE>
gtk_selection_request
</SECTION>
+<SECTION>
+<FILE>gtkclipboard</FILE>
+<TITLE>Clipboards</TITLE>
+GtkClipboard
+GtkClipboardReceivedFunc
+GtkClipboardTextReceivedFunc
+GtkClipboardGetFunc
+GtkClipboardClearFunc
+gtk_clipboard_get
+gtk_clipboard_set_with_data
+gtk_clipboard_set_with_owner
+gtk_clipboard_get_owner
+gtk_clipboard_clear
+gtk_clipboard_set_text
+gtk_clipboard_request_contents
+gtk_clipboard_request_text
+gtk_clipboard_wait_for_contents
+gtk_clipboard_wait_for_text
+</SECTION>
+
<SECTION>
<FILE>gtkdnd</FILE>
<TITLE>Drag and Drop</TITLE>
GtkSignalMarshal
GtkSignalDestroy
GtkEmissionHook
-GtkSignalQuery
GtkSignalRunType
gtk_signal_init
gtk_signal_new
gtk_signal_emit_by_name
gtk_signal_emitv
gtk_signal_emitv_by_name
-gtk_signal_n_emissions
-gtk_signal_n_emissions_by_name
gtk_signal_emit_stop
gtk_signal_emit_stop_by_name
gtk_signal_connect
gtk_signal_handler_pending_by_id
gtk_signal_handlers_destroy
gtk_signal_set_funcs
-gtk_signal_query
gtk_signal_add_emission_hook
gtk_signal_add_emission_hook_full
gtk_signal_remove_emission_hook
</SECTION>
-<SECTION>
-<FILE>gtkmarshal</FILE>
-<TITLE>Signal Marshallers</TITLE>
-gtk_signal_default_marshaller
-
-<SUBSECTION Private>
-gtk_marshal_BOOL__POINTER_INT_INT_UINT
-gtk_marshal_BOOL__POINTER_STRING_STRING_POINTER
-gtk_marshal_ENUM__ENUM
-gtk_marshal_NONE__BOXED
-gtk_marshal_NONE__ENUM
-gtk_marshal_NONE__ENUM_FLOAT
-gtk_marshal_NONE__ENUM_FLOAT_BOOL
-gtk_marshal_NONE__OBJECT
-gtk_marshal_NONE__POINTER_STRING_STRING
-gtk_marshal_NONE__POINTER_UINT
-gtk_marshal_NONE__POINTER_UINT_ENUM
-gtk_marshal_NONE__POINTER_POINTER_UINT_UINT
-gtk_marshal_NONE__POINTER_INT_INT_POINTER_UINT_UINT
-gtk_marshal_NONE__POINTER_UINT_UINT
-gtk_marshal_NONE__STRING
-gtk_marshal_NONE__STRING_INT_POINTER
-gtk_marshal_NONE__UINT
-gtk_marshal_NONE__UINT_POINTER_UINT_ENUM_ENUM_POINTER
-gtk_marshal_NONE__UINT_POINTER_UINT_UINT_ENUM
-gtk_marshal_NONE__UINT_STRING
-gtk_marshal_BOOL__NONE
-gtk_marshal_BOOL__POINTER
-gtk_marshal_BOOL__POINTER_INT_INT
-gtk_marshal_BOOL__POINTER_INT_INT_INT
-gtk_marshal_BOOL__POINTER_POINTER_INT_INT
-gtk_marshal_BOOL__POINTER_POINTER_POINTER_POINTER
-gtk_marshal_INT__INT
-gtk_marshal_INT__POINTER
-gtk_marshal_INT__POINTER_CHAR_CHAR
-gtk_marshal_NONE__BOOL
-gtk_marshal_NONE__INT
-gtk_marshal_NONE__INT_FLOAT
-gtk_marshal_NONE__INT_FLOAT_BOOL
-gtk_marshal_NONE__INT_INT
-gtk_marshal_NONE__INT_INT_POINTER
-gtk_marshal_NONE__INT_POINTER
-gtk_marshal_NONE__INT_POINTER_INT_INT_INT
-gtk_marshal_NONE__INT_POINTER_INT_INT_INT_POINTER
-gtk_marshal_NONE__NONE
-gtk_marshal_NONE__POINTER
-gtk_marshal_NONE__POINTER_INT
-gtk_marshal_NONE__POINTER_INT_INT
-gtk_marshal_NONE__POINTER_INT_INT_POINTER_INT_INT
-gtk_marshal_NONE__POINTER_INT_POINTER
-gtk_marshal_NONE__POINTER_POINTER
-gtk_marshal_NONE__POINTER_POINTER_INT_INT
-gtk_marshal_NONE__POINTER_POINTER_POINTER
-gtk_marshal_INT__OBJECT_BOXED_POINTER
-gtk_marshal_INT__POINTER_POINTER_POINTER
-gtk_marshal_NONE__POINTER_POINTER_INT
-gtk_marshal_NONE__STRING_POINTER
-gtk_marshal_NONE__INT_INT_INT
-</SECTION>
-
<SECTION>
<FILE>gtkarg</FILE>
<TITLE>Object Properties</TITLE>
</para>
-<!-- ##### SECTION ./tmpl/gtkclipboard.sgml:See_Also ##### -->
-<para>
-<variablelist>
-
-<varlistentry>
-<term>#GtkSelection</term>
-<listitem><para>@GtkClipboard provides a high-level wrapper around the
- lower level routines that deal with X selections. It is
- also possibly to directly manipulate the X selections,
- though it is seldom necessary to do so.</para></listitem>
-</varlistentry>
-
-</variablelist>
-</para>
-
+<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Long_Description ##### -->
+<refsect2>
+<title>What are Signal Marshallers?</title>
+<para>
+Marshals are functions which all have the same prototype:
+they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
+and an array of argument values.
+The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
+</para>
+<para>
+They then call a native function: the GtkObject is the first
+parameter passed in. The arguments are passed in the native
+calling convention: chars, shorts, ints, longs may be packed
+on the stack, or tucked in registers: it doesn't matter
+because the same calling convention will be generated
+inside the gtkmarshal code as is expected where you define
+your handlers.
+</para>
+<para>
+So the function named:
+<programlisting>
+gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
+</programlisting>
+will call the #GtkSignalFunc assuming it was a function with signature:
+<programlisting>
+gboolean sigfunc(gpointer,gint,gint,guint);
+</programlisting>
+</para>
+</refsect2>
+<refsect2>
+<title>Writing Custom Marshals</title>
+<para>
+Marshals are primarily used as arguments to gtk_signal_new().
+Sometimes, you may find that a marshaller you need isn't available
+in the standard list. Then you have to write your own.
+</para>
+<para>
+If you wish to define a signal with a new type of argument list.
+Suppose you want 2 pointers and 2 integers.
+You would write:
+<programlisting>
+typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
+ gpointer, gpointer, gint, gint
+);
+
+void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object,
+ GtkSignalFunc func,
+ gpointer func_data,
+ GtkArg* args)
+{
+ GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
+ gint* return_val;
+ return_val = GTK_RETLOC_INT(args[4]);
+ rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
+ *return_val = (*rfunc)(object,
+ GTK_VALUE_POINTER(args[0]),
+ GTK_VALUE_POINTER(args[1]),
+ GTK_VALUE_INT(args[2]),
+ GTK_VALUE_INT(args[3]),
+ func_data);
+}
+</programlisting>
+</para>
+</refsect2>
-<!-- ##### FUNCTION gtk_clipboard_get ##### -->
-<para>
-
-</para>
-
-@selection:
-@Returns:
<!-- ##### SECTION ./tmpl/gtkmenufactory.sgml:Short_Description ##### -->
@container:
+<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Title ##### -->
+Signal Marshallers
+
+
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Long_Description ##### -->
<para>
@func_data:
@args:
+<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
+<para>
+This is currently a hack left in for a scheme wrapper library.
+It may be removed.
+</para>
+<para>
+Don't use it.
+</para>
+
+@object: The object which emits the signal.
+@data: The user data associated with the hook.
+@nparams: The number of parameters to the function.
+@args: The actual values of the arguments.
+@arg_types: The types of the arguments.
+@return_type: The type of the return value from the function
+or #GTK_TYPE_NONE for no return value.
+
+<!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
+<para>
+Add an emission hook for a type of signal, for any object.
+(with control of what happens when the hook is
+destroyed).
+</para>
+
+@signal_id: the type of signal add the hook for.
+@hook_func: the function to invoke to handle the hook.
+@data: the user data passed in to hook_func.
+@destroy: a function to invoke when the hook is destroyed,
+to clean up any allocation done just for this
+signal handler.
+@Returns: the id (that you may pass as a parameter
+to gtk_signal_remove_emission_hook()).
+
<!-- ##### FUNCTION gtk_text_buffer_paste_primary_selection ##### -->
<para>
@func_data:
@args:
-<!-- ##### FUNCTION gtk_clipboard_set_with_data ##### -->
-<para>
-
-</para>
-
-@clipboard:
-@targets:
-@n_targets:
-@get_func:
-@clear_func:
-@user_data:
-@Returns:
-
<!-- ##### SIGNAL GtkTextView::copy-text ##### -->
<para>
@x:
@y:
-<!-- ##### USER_FUNCTION GtkClipboardReceivedFunc ##### -->
-<para>
- A function to be called when the results of gtk_clipboard_request_text()
- are received, or when the request fails.
-</para>
-
-@clipboard: the #GtkClipboard
-@selection_data: a #GtkSelectionData containing the data was received.
- If retrieving the data failed, then then length field
- of @selection_data will be negative.
-@data: the @user_data supplied to gtk_clipboard_request_contents().
-
-<!-- ##### FUNCTION gtk_clipboard_clear ##### -->
-<para>
-
-</para>
-
-@clipboard:
-
-<!-- ##### FUNCTION gtk_clipboard_wait_for_contents ##### -->
-<para>
-
-</para>
-
-@clipboard:
-@target:
-@Returns:
-
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:Short_Description ##### -->
</para>
-<!-- ##### USER_FUNCTION GtkClipboardClearFunc ##### -->
-<para>
-A function that will be called when the contents of the clipboard are changed
-or cleared. Once this has called, the @user_data_or_owner argument
-will not be used again.
-</para>
-
-@clipboard: the #GtkClipboard
-@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
- the @owner argument passed to gtk_clipboard_set_owner()
-
<!-- ##### MACRO GTK_WIDGET_IS_OFFSCREEN ##### -->
<para>
@func_data:
@args:
-<!-- ##### SECTION ./tmpl/gtkclipboard.sgml:Long_Description ##### -->
- <para>
- The #GtkClipboard object represents a clipboard of data shared
- between different processes or between different widgets in
- the same process. Each clipboard is identified by a name encoded as a
- #GdkAtom. (Conversion to and from strings can be done with
- gdk_atom_intern() and gdk_atom_name().) The default clipboard
- corresponds to the CLIPBOARD atom; another commonly used clipboard
- is the PRIMARY clipboard, which, in X, traditionally contains
- the currently selected text.
- </para>
- <para>
- To support having a number of different formats on the clipboard
- at the same time, the clipboard mechanism allows providing
- callbacks instead of the actual data. When you set the contents
- of the clipboard, you can either supply the data directly (via
- functions like gtk_clipboard_set_text()), or you can supply a
- callback to be called at a later time when the data is needed (via
- gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().)
- Providing a callback also avoids having to make copies of the data
- when it is not needed.
- </para>
- <para>
- gtk_clipboard_set_with_data() and gtk_clipboard_set_with_owner()
- are quite similar; the choice between the two depends mostly on
- which is more convenient in a particular situation.
- The former is most useful when you want to have a blob of data
- with callbacks to convert it into the various data types that you
- advertise. When the @clear_func you provided is called, you
- simply free the data blob. The latter is more useful when the
- contents of clipboard reflect the internal state of a @GObject
- (As an example, for the PRIMARY clipboard, when an entry widget
- provides the clipboard's contents the contents are simply the
- text within the selected region.) If the contents change, the
- entry widget can call gtk_clipboard_set_with_owner() to update
- the timestamp for clipboard ownership, without having to worry
- about @clear_func being called.
- </para>
- <para>
- Requesting the data from the clipboard is essentially
- asynchronous. If the contents of the clipboard are provided within
- the same process, then a direct function call will be made to
- retrieve the data, but if they are provided by another process,
- then the data needs to be retrieved from the other process, which
- may take some time. To avoid blocking the user interface, the call
- to request the selection, gtk_clipboard_request_contents() takes a
- callback that will be called when the contents are received (or
- when the request fails.) If you don't want to deal with providing
- a separate callback, you can also use gtk_clipboard_wait_for_contents().
- What this does is run the Glib main loop recursively waiting for
- the contents. This can simplify the code flow, but you still have
- to be aware that other callbacks in your program can be called
- while this recursive mainloop is running.
- </para>
- <para>
- Along with the functions to get the clipboard contents as an
- arbitrary data chunk, there are also functions to retrieve
- it as text, gtk_clipboard_request_text() and
- gtk_clipboard_wait_for_text(). These functions take care of
- determining which formats are advertised by the clipboard
- provider, asking for the clipboard in the best available format
- and converting the results into the UTF-8 encoding. (The standard
- form for representing strings in GTK+.)
- </para>
-
-
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:See_Also ##### -->
<para>
@subfactory:
@path:
-<!-- ##### SECTION ./tmpl/gtkclipboard.sgml:Short_Description ##### -->
-Storing data on Clipboards.
-
-
<!-- ##### FUNCTION gtk_type_children_types ##### -->
<para>
Return the pointer to the type's children's types.
</para>
+<!-- ##### STRUCT GtkSignalQuery ##### -->
+<para>
+This structure contains all the information about a particular
+signal: its name, the type it affects, the signature of the handlers,
+and its unique identifying integer.
+</para>
+
+@object_type:
+@signal_id:
+@signal_name:
+@is_user_signal:
+@signal_flags:
+@return_val:
+@nparams:
+@params:
+
<!-- ##### FUNCTION gtk_type_describe_tree ##### -->
<para>
Given a @type, describe all of its children, and their children. Only
@type: GtkType
@show_size: gboolean
-<!-- ##### FUNCTION gtk_clipboard_request_contents ##### -->
-<para>
-
-</para>
-
-@clipboard:
-@target:
-@callback:
-@user_data:
-
<!-- ##### FUNCTION gtk_marshal_BOOL__POINTER_INT_INT_INT ##### -->
<para>
@func_data:
@args:
-<!-- ##### FUNCTION gtk_clipboard_get_owner ##### -->
-<para>
-
-</para>
-
-@clipboard:
-@Returns:
-
<!-- ##### SECTION ./tmpl/gtkdebug.sgml:Long_Description ##### -->
<para>
@charsets: a NULL-terminated array of strings containing charset names which
will be shown, or NULL to show all charsets.
-<!-- ##### SECTION ./tmpl/gtkclipboard.sgml:Title ##### -->
-Clipboards
-
-
<!-- ##### SIGNAL GtkTextView::delete-text ##### -->
<para>
@parent_t:
@seqno:
+<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:Short_Description ##### -->
+Functions to adapt C structures to native calling convention.
+
+
<!-- ##### MACRO GTK_TYPE_FLAT_LAST ##### -->
<para>
The last "flat" (no struct) enumerated type value.
</para>
+<!-- ##### FUNCTION gtk_text_mark_unref ##### -->
+<para>
+
+</para>
+
+@mark:
+
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER ##### -->
<para>
@func_data:
@args:
+<!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
+<para>
+Destroy all the signal handlers connected to an object.
+This is done automatically when the object is destroyed.
+</para>
+<para>
+This function is labeled private.
+</para>
+
+@object: the object whose signal handlers should be destroyed.
+
<!-- ##### FUNCTION gtk_text_iter_in_region ##### -->
<para>
@foreign_type: GtkType
@Returns: GtkType
-<!-- ##### FUNCTION gtk_clipboard_wait_for_text ##### -->
-<para>
-
-</para>
-
-@clipboard:
-@Returns: <!--
-Local variables:
-mode: sgml
-sgml-parent-document: ("../gtk-docs.sgml" "book" "refsect2" "")
-End:
--->
-
<!-- ##### STRUCT GtkMenuFactory ##### -->
<para>
@GTK_DEBUG_DND:
@GTK_DEBUG_PLUGSOCKET:
-<!-- ##### FUNCTION gtk_clipboard_set_with_owner ##### -->
-<para>
-
-</para>
-
-@clipboard:
-@targets:
-@n_targets:
-@get_func:
-@clear_func:
-@owner:
-@Returns:
-
<!-- ##### FUNCTION gtk_menu_factory_remove_paths ##### -->
<para>
</para>
+<!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
+<para>
+Returns whether a connection id is valid (and optionally not blocked).
+</para>
+
+@object: the object to search for the desired handler.
+@handler_id: the connection id.
+@may_be_blocked: whether it is acceptable to return a blocked
+handler.
+@Returns: TRUE if the signal exists and wasn't blocked,
+unless #may_be_blocked was specified. FALSE otherwise.
+
<!-- ##### MACRO GTK_PRIVATE_FLAGS ##### -->
<para>
@func_data:
@args:
+<!-- ##### SECTION ./tmpl/gtkmarshal.sgml:See_Also ##### -->
+<para>
+<variablelist>
+
+<varlistentry>
+<term>#GtkSignal</term>
+<listitem><para>The signal handling functions (of which marshallers are
+really an implementation detail).</para></listitem>
+</varlistentry>
+
+</variablelist>
+</para>
+
+
<!-- ##### MACRO GTK_WIDGET_RESIZE_NEEDED ##### -->
<para>
@buffer:
-<!-- ##### STRUCT GtkTextTabArray ##### -->
+<!-- ##### MACRO gtk_signal_default_marshaller ##### -->
<para>
-
+A marshaller that returns void and takes no extra parameters.
</para>
-<!-- ##### ARG GtkTextTag:overstrike ##### -->
+<!-- ##### STRUCT GtkTextTabArray ##### -->
<para>
</para>
-<!-- ##### USER_FUNCTION GtkClipboardTextReceivedFunc ##### -->
+<!-- ##### ARG GtkTextTag:overstrike ##### -->
<para>
- A function to be called when the results of gtk_clipboard_request_text()
- are received, or when the request fails.
+
</para>
-@clipboard: the #GtkClipboard
-@text: the text received, as a UTF-8 encoded string, or %NULL
- if retrieving the data failed.
-@data: the @user_data supplied to gtk_clipboard_request_text().
<!-- ##### MACRO GTK_WIDGET_HAS_SHAPE_MASK ##### -->
<para>
@buffer:
@time:
+<!-- ##### FUNCTION gtk_text_mark_ref ##### -->
+<para>
+
+</para>
+
+@mark:
+@Returns:
+
<!-- ##### FUNCTION gtk_marshal_NONE__POINTER_INT ##### -->
<para>
@func_data:
@args:
-<!-- ##### USER_FUNCTION GtkClipboardGetFunc ##### -->
-<para>
-A function that will be called to provide the contents of the selection.
-If multiple types of data were advertised, the requested type can
-be determined from the @info parameter or by checking the target field
-of @selection_data. If the data could succesfully be converted into
-then it should be stored into the @selection_data object by
-calling gtk_selection_data_set() (or related functions such
-as gtk_seletion_data_get().) If no data is set, the requestor
-will be informed that the attempt to get the data failed.
-</para>
-
-@clipboard: the #GtkClipboard
-@selection_data: a #GtkSelectionData argument in which the requested
- data should be stored.
-@info: the info field corresponding to the requested
- target from the #GtkTargetEntry array passed to
- gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().
-@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
- the @owner argument passed to gtk_clipboard_set_owner()
-
<!-- ##### MACRO gtk_marshal_NONE__OBJECT ##### -->
<para>
</para>
-<!-- ##### FUNCTION gtk_clipboard_set_text ##### -->
-<para>
-
-</para>
-
-@clipboard:
-@text:
-@len:
-
<!-- ##### FUNCTION gtk_type_set_varargs_type ##### -->
<para>
Set the varargs type for a fundamental type @foreign_type.
fundamental type.
@varargs_type: Must be a GtkType which is either structured or flag, or NONE.
-<!-- ##### STRUCT GtkClipboard ##### -->
-<para>
-
-</para>
-
-
<!-- ##### FUNCTION gtk_type_check_class_cast ##### -->
<para>
Given a GtkTypeClass pointer @klass, and a GtkType @cast_type, make
@factory:
+<!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
+<para>
+Find out the recursion depth of emissions for a particular type
+of signal and object. (So it will
+always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
+This is a way to avoid recursion: you can see if
+you are currently running in that signal handler and emit it only
+if you are.
+</para>
+<para>Another way to look at it is that this number increases
+by one when #gtk_signal_emit(), et al, are called,
+and decreases by one when #gtk_signal_emit() returns.
+</para>
+
+@object: the object with the signal handler.
+@signal_id: the signal id.
+@Returns: the recursion depth of emissions of this signal for this
+object.
+
<!-- ##### FUNCTION gtk_text_buffer_insert_pixmap ##### -->
<para>
@entries:
@nentries:
+<!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
+<para>
+These set default functions to call when the user didn't
+supply a function when connecting. (These are rarely
+used, and probably only for language bindings)
+</para>
+<para>
+By default, there are no such functions.
+</para>
+
+@marshal_func: the function to invoke on every handlers for which there
+isn't a function pointer. May be NULL.
+@destroy_func: the function to invoke when each hook is destroyed.
+May be NULL.
+
<!-- ##### FUNCTION gtk_im_context_simple_new ##### -->
<para>
@type: GtkType
@Returns: gpointer to the klass.
-<!-- ##### FUNCTION gtk_window_set_default ##### -->
+<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
<para>
-
+A function which you can use to clean up when the
+signal handler is destroyed.
+</para>
+<para>
+For example, if your handler requires a few variables
+that you made into a struct and allocated (using g_new()
+or something), then you will probably want to free
+it as soon as the hook is destroyed. This will
+allow you to do that. (For this in particular
+it is convenient to pass g_free() as a #GtkSignalDestroy
+function).
</para>
-@window:
-@defaultw:
+@data: The user data associated with the hook that is being
+destroyed.
-<!-- ##### FUNCTION gtk_clipboard_request_text ##### -->
+<!-- ##### FUNCTION gtk_window_set_default ##### -->
<para>
</para>
-@clipboard:
-@callback:
-@user_data:
+@window:
+@defaultw:
<!-- ##### FUNCTION gtk_marshal_NONE__INT ##### -->
<para>
</para>
+<!-- ##### FUNCTION gtk_signal_query ##### -->
+<para>
+Obtain information about a signal.
+</para>
+
+@signal_id: the signal type identifier.
+@Returns: a pointer to a GtkSignalQuery structure
+which contains all the information, or NULL.
+The pointer is allocated just for you: you must g_free() it.
+
+<!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
+<para>
+Find out the recursion depth of emissions for a particular type
+of signal and object. Just like gtk_signal_n_emissions()
+except it will lookup the signal id for you.
+</para>
+
+@object: the object with the signal handler.
+@name: the signal name.
+@Returns: the recursion depth of emissions of this signal for this
+object.
+
<!-- ##### SECTION ./tmpl/gtkenums.sgml.sgml:See_Also ##### -->
<para>
@GTK_TEXT_SCROLL_PAGE_DOWN:
@GTK_TEXT_SCROLL_PAGE_UP:
+<!-- ##### STRUCT GtkTextBTree ##### -->
+<para>
+
+</para>
+
+
@Returns: The current #GtkReliefStyle
-<!-- ##### SIGNAL GtkButton::pressed ##### -->
+<!-- ##### SIGNAL GtkButton::clicked ##### -->
<para>\r
-Emitted when the button is initially pressed.\r
+Emitted when a button clicked on by the mouse and the cursor stays on the\r
+button. If the cursor is not on the button when the mouse button is released,\r
+the signal is not emitted.\r
</para>
@button: the object which received the signal.
-<!-- ##### SIGNAL GtkButton::released ##### -->
+<!-- ##### SIGNAL GtkButton::enter ##### -->
<para>\r
-Emitted when a button which is pressed is released, no matter where the\r
-mouse cursor is.\r
+Emitted when the mouse cursor enters the region of the button.\r
</para>
@button: the object which received the signal.
-<!-- ##### SIGNAL GtkButton::clicked ##### -->
+<!-- ##### SIGNAL GtkButton::leave ##### -->
<para>\r
-Emitted when a button clicked on by the mouse and the cursor stays on the\r
-button. If the cursor is not on the button when the mouse button is released,\r
-the signal is not emitted.\r
+Emitted when the mouse cursor leaves the region of the button.\r
</para>
@button: the object which received the signal.
-<!-- ##### SIGNAL GtkButton::enter ##### -->
+<!-- ##### SIGNAL GtkButton::pressed ##### -->
<para>\r
-Emitted when the mouse cursor enters the region of the button.\r
+Emitted when the button is initially pressed.\r
</para>
@button: the object which received the signal.
-<!-- ##### SIGNAL GtkButton::leave ##### -->
+<!-- ##### SIGNAL GtkButton::released ##### -->
<para>\r
-Emitted when the mouse cursor leaves the region of the button.\r
+Emitted when a button which is pressed is released, no matter where the\r
+mouse cursor is.\r
</para>
@button: the object which received the signal.
@calendar: a #GtkCalendar.
-<!-- ##### SIGNAL GtkCalendar::month-changed ##### -->
+<!-- ##### SIGNAL GtkCalendar::day-selected ##### -->
<para>
-Emitted when the user clicks a button to change the selected month on a
-calendar.
+Emitted when the user selects a day.
</para>
@calendar: the object which received the signal.
-<!-- ##### SIGNAL GtkCalendar::day-selected ##### -->
+<!-- ##### SIGNAL GtkCalendar::day-selected-double-click ##### -->
<para>
-Emitted when the user selects a day.
+
</para>
@calendar: the object which received the signal.
-<!-- ##### SIGNAL GtkCalendar::day-selected-double-click ##### -->
+<!-- ##### SIGNAL GtkCalendar::month-changed ##### -->
<para>
-
+Emitted when the user clicks a button to change the selected month on a
+calendar.
</para>
@calendar: the object which received the signal.
-<!-- ##### SIGNAL GtkCalendar::prev-month ##### -->
+<!-- ##### SIGNAL GtkCalendar::next-month ##### -->
<para>
</para>
@calendar: the object which received the signal.
-<!-- ##### SIGNAL GtkCalendar::next-month ##### -->
+<!-- ##### SIGNAL GtkCalendar::next-year ##### -->
<para>
</para>
@calendar: the object which received the signal.
-<!-- ##### SIGNAL GtkCalendar::prev-year ##### -->
+<!-- ##### SIGNAL GtkCalendar::prev-month ##### -->
<para>
</para>
@calendar: the object which received the signal.
-<!-- ##### SIGNAL GtkCalendar::next-year ##### -->
+<!-- ##### SIGNAL GtkCalendar::prev-year ##### -->
<para>
</para>
and converting the results into the UTF-8 encoding. (The standard
form for representing strings in GTK+.)
</para>
-
+
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
</para>
-<!-- ##### FUNCTION gtk_clipboard_get ##### -->
-<para>
-
-</para>
-
-@selection:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_clipboard_set_with_data ##### -->
+<!-- ##### USER_FUNCTION GtkClipboardReceivedFunc ##### -->
<para>
-
+ A function to be called when the results of gtk_clipboard_request_text()
+ are received, or when the request fails.
</para>
-@clipboard:
-@targets:
-@n_targets:
-@get_func:
-@clear_func:
-@user_data:
-@Returns:
+@clipboard: the #GtkClipboard
+@selection_data: a #GtkSelectionData containing the data was received.
+ If retrieving the data failed, then then length field
+ of @selection_data will be negative.
+@data: the @user_data supplied to gtk_clipboard_request_contents().
-<!-- ##### FUNCTION gtk_clipboard_set_with_owner ##### -->
+<!-- ##### USER_FUNCTION GtkClipboardTextReceivedFunc ##### -->
<para>
-
+ A function to be called when the results of gtk_clipboard_request_text()
+ are received, or when the request fails.
</para>
-@clipboard:
-@targets:
-@n_targets:
-@get_func:
-@clear_func:
-@owner:
-@Returns:
+@clipboard: the #GtkClipboard
+@text: the text received, as a UTF-8 encoded string, or %NULL
+ if retrieving the data failed.
+@data: the @user_data supplied to gtk_clipboard_request_text().
<!-- ##### USER_FUNCTION GtkClipboardGetFunc ##### -->
will be informed that the attempt to get the data failed.
</para>
-@clipboard: the #GtkClipboard
-@selection_data: a #GtkSelectionData argument in which the requested
- data should be stored.
-@info: the info field corresponding to the requested
+@clipboard: the #GtkClipboard
+@selection_data: a #GtkSelectionData argument in which the requested
+ data should be stored.
+@info: the info field corresponding to the requested
target from the #GtkTargetEntry array passed to
gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().
@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
the @owner argument passed to gtk_clipboard_set_owner()
+
<!-- ##### USER_FUNCTION GtkClipboardClearFunc ##### -->
<para>
A function that will be called when the contents of the clipboard are changed
will not be used again.
</para>
-@clipboard: the #GtkClipboard
+@clipboard: the #GtkClipboard
@user_data_or_owner: the @user_data argument passed to gtk_clipboard_set_with_data(), or
the @owner argument passed to gtk_clipboard_set_owner()
-<!-- ##### FUNCTION gtk_clipboard_get_owner ##### -->
+<!-- ##### FUNCTION gtk_clipboard_get ##### -->
+<para>
+
+</para>
+
+@selection:
+@Returns:
+
+
+<!-- ##### FUNCTION gtk_clipboard_set_with_data ##### -->
<para>
</para>
@clipboard:
+@targets:
+@n_targets:
+@get_func:
+@clear_func:
+@user_data:
@Returns:
-<!-- ##### FUNCTION gtk_clipboard_clear ##### -->
+<!-- ##### FUNCTION gtk_clipboard_set_with_owner ##### -->
<para>
</para>
@clipboard:
+@targets:
+@n_targets:
+@get_func:
+@clear_func:
+@owner:
+@Returns:
-<!-- ##### FUNCTION gtk_clipboard_set_text ##### -->
+<!-- ##### FUNCTION gtk_clipboard_get_owner ##### -->
<para>
</para>
@clipboard:
-@text:
-@len:
+@Returns:
-<!-- ##### FUNCTION gtk_clipboard_request_contents ##### -->
+<!-- ##### FUNCTION gtk_clipboard_clear ##### -->
<para>
</para>
@clipboard:
-@target:
-@callback:
-@user_data:
-<!-- ##### USER_FUNCTION GtkClipboardReceivedFunc ##### -->
+<!-- ##### FUNCTION gtk_clipboard_set_text ##### -->
<para>
- A function to be called when the results of gtk_clipboard_request_text()
- are received, or when the request fails.
+
</para>
-@clipboard: the #GtkClipboard
-@selection_data: a #GtkSelectionData containing the data was received.
- If retrieving the data failed, then then length field
- of @selection_data will be negative.
-@data: the @user_data supplied to gtk_clipboard_request_contents().
+@clipboard:
+@text:
+@len:
-<!-- ##### FUNCTION gtk_clipboard_request_text ##### -->
+<!-- ##### FUNCTION gtk_clipboard_request_contents ##### -->
<para>
</para>
@clipboard:
+@target:
@callback:
@user_data:
-<!-- ##### USER_FUNCTION GtkClipboardTextReceivedFunc ##### -->
+<!-- ##### FUNCTION gtk_clipboard_request_text ##### -->
<para>
- A function to be called when the results of gtk_clipboard_request_text()
- are received, or when the request fails.
+
</para>
-@clipboard: the #GtkClipboard
-@text: the text received, as a UTF-8 encoded string, or %NULL
- if retrieving the data failed.
-@data: the @user_data supplied to gtk_clipboard_request_text().
+@clipboard:
+@callback:
+@user_data:
<!-- ##### FUNCTION gtk_clipboard_wait_for_contents ##### -->
@clipboard:
@Returns:
-
-
<!--
Local variables:
mode: sgml
sgml-parent-document: ("../gtk-docs.sgml" "book" "refsect2" "")
End:
-->
+
+
@adjustment: A pointer to a #GtkAdjustment widget, or NULL.
-<!-- ##### SIGNAL GtkCList::select-row ##### -->
+<!-- ##### SIGNAL GtkCList::abort-column-resize ##### -->
<para>
-This signal is emitted when the user selects a row in the list.
-It is emitted for every row that is selected in a multi-selection or
-by calling gtk_clist_select_all().
+This signal is emitted when a column resize is aborted.
</para>
-@clist: The object which received the signal.
-@row: The row selected.
-@column: The column where the selection occured.
-@event: A #GdkEvent structure for the selection.
+@clist: the object which received the signal.
-<!-- ##### SIGNAL GtkCList::unselect-row ##### -->
+<!-- ##### SIGNAL GtkCList::click-column ##### -->
<para>
-This signal is emitted when the user unselects a row in the list.
-It is emitted for every row that is unselected in a multi-selection or
-by calling gtk_clist_unselect_all(). It is also emitted for the
-previously selected row in a "single" or "browse" mode CList.
+This signal is emitted when a column title is clicked.
</para>
@clist: The object which received the signal.
-@row: The selected row
-@column: The column where the selection occured.
-@event:
+@column: The number of the column.
-<!-- ##### SIGNAL GtkCList::row-move ##### -->
+<!-- ##### SIGNAL GtkCList::end-selection ##### -->
<para>
-This signal is emitted when a row is moved.
+This signal is emitted when a selection ends in a
+multiple selection CList.
</para>
-@clist: The object which received the signal.
-@arg1: The source position of the row.
-@arg2: The destination position of the row.
+@clist: the object which received the signal.
-<!-- ##### SIGNAL GtkCList::click-column ##### -->
+<!-- ##### SIGNAL GtkCList::extend-selection ##### -->
<para>
-This signal is emitted when a column title is clicked.
+This signal is emitted when the selection is extended.
</para>
-@clist: The object which received the signal.
-@column: The number of the column.
+@clist: the object which received the signal.
+@scroll_type: A #GtkScrollType value of any scrolling operation the
+occured during the selection.
+@position: A value between 0.0 and 1.0.
+@auto_start_selection: %TRUE or %FALSE.
<!-- ##### SIGNAL GtkCList::resize-column ##### -->
<para>
@column: The number of the column
@width: The new width of the column.
-<!-- ##### SIGNAL GtkCList::toggle-focus-row ##### -->
+<!-- ##### SIGNAL GtkCList::row-move ##### -->
<para>
-
+This signal is emitted when a row is moved.
</para>
@clist: The object which received the signal.
+@arg1: The source position of the row.
+@arg2: The destination position of the row.
-<!-- ##### SIGNAL GtkCList::select-all ##### -->
+<!-- ##### SIGNAL GtkCList::scroll-horizontal ##### -->
<para>
-This signal is emitted when all the rows are selected in a CList.
+This signal is emitted when the CList is scrolled horizontally.
</para>
@clist: the object which received the signal.
+@scroll_type: A #GtkScrollType value of how the scroll operation occured.
+@position: a value between 0.0 and 1.0.
-<!-- ##### SIGNAL GtkCList::unselect-all ##### -->
+<!-- ##### SIGNAL GtkCList::scroll-vertical ##### -->
<para>
-This signal is emitted when all rows are unselected in a CList.
+This signal is emitted when the CList is scrolled vertically.
</para>
@clist: the object which received the signal.
+@scroll_type: A #GtkScrollType value of how the scroll operation occured.
+@position: A value between 0.0 and 1.0.
-<!-- ##### SIGNAL GtkCList::undo-selection ##### -->
+<!-- ##### SIGNAL GtkCList::select-all ##### -->
<para>
-This signal is emitted when an undo selection occurs in the CList,
-probably via calling gtk_clist_undo_selection().
+This signal is emitted when all the rows are selected in a CList.
</para>
@clist: the object which received the signal.
-<!-- ##### SIGNAL GtkCList::start-selection ##### -->
+<!-- ##### SIGNAL GtkCList::select-row ##### -->
<para>
-This signal is emitted when a drag-selection is started in
-a multiple-selection CList.
+This signal is emitted when the user selects a row in the list.
+It is emitted for every row that is selected in a multi-selection or
+by calling gtk_clist_select_all().
+</para>
+
+@clist: The object which received the signal.
+@row: The row selected.
+@column: The column where the selection occured.
+@event: A #GdkEvent structure for the selection.
+
+<!-- ##### SIGNAL GtkCList::set-scroll-adjustments ##### -->
+<para>
+
</para>
@clist: the object which received the signal.
+@arg1:
+@arg2:
-<!-- ##### SIGNAL GtkCList::end-selection ##### -->
+<!-- ##### SIGNAL GtkCList::start-selection ##### -->
<para>
-This signal is emitted when a selection ends in a
-multiple selection CList.
+This signal is emitted when a drag-selection is started in
+a multiple-selection CList.
</para>
@clist: the object which received the signal.
@clist: the object which received the signal.
-<!-- ##### SIGNAL GtkCList::extend-selection ##### -->
+<!-- ##### SIGNAL GtkCList::toggle-focus-row ##### -->
<para>
-This signal is emitted when the selection is extended.
+
</para>
-@clist: the object which received the signal.
-@scroll_type: A #GtkScrollType value of any scrolling operation the
-occured during the selection.
-@position: A value between 0.0 and 1.0.
-@auto_start_selection: %TRUE or %FALSE.
+@clist: The object which received the signal.
-<!-- ##### SIGNAL GtkCList::scroll-vertical ##### -->
+<!-- ##### SIGNAL GtkCList::undo-selection ##### -->
<para>
-This signal is emitted when the CList is scrolled vertically.
+This signal is emitted when an undo selection occurs in the CList,
+probably via calling gtk_clist_undo_selection().
</para>
@clist: the object which received the signal.
-@scroll_type: A #GtkScrollType value of how the scroll operation occured.
-@position: A value between 0.0 and 1.0.
-<!-- ##### SIGNAL GtkCList::scroll-horizontal ##### -->
+<!-- ##### SIGNAL GtkCList::unselect-all ##### -->
<para>
-This signal is emitted when the CList is scrolled horizontally.
+This signal is emitted when all rows are unselected in a CList.
</para>
@clist: the object which received the signal.
-@scroll_type: A #GtkScrollType value of how the scroll operation occured.
-@position: a value between 0.0 and 1.0.
-<!-- ##### SIGNAL GtkCList::abort-column-resize ##### -->
+<!-- ##### SIGNAL GtkCList::unselect-row ##### -->
<para>
-This signal is emitted when a column resize is aborted.
+This signal is emitted when the user unselects a row in the list.
+It is emitted for every row that is unselected in a multi-selection or
+by calling gtk_clist_unselect_all(). It is also emitted for the
+previously selected row in a "single" or "browse" mode CList.
</para>
-@clist: the object which received the signal.
+@clist: The object which received the signal.
+@row: The selected row
+@column: The column where the selection occured.
+@event:
<!-- ##### ARG GtkCList:n_columns ##### -->
<para>
@container: the object which received the signal.
@widget:
-<!-- ##### SIGNAL GtkContainer::remove ##### -->
+<!-- ##### SIGNAL GtkContainer::check-resize ##### -->
<para>
</para>
@container: the object which received the signal.
-@widget:
-<!-- ##### SIGNAL GtkContainer::check-resize ##### -->
+<!-- ##### SIGNAL GtkContainer::focus ##### -->
<para>
</para>
@container: the object which received the signal.
+@direction:
+@Returns:
-<!-- ##### SIGNAL GtkContainer::focus ##### -->
+<!-- ##### SIGNAL GtkContainer::remove ##### -->
<para>
</para>
@container: the object which received the signal.
-@direction:
-@Returns:
+@widget:
<!-- ##### SIGNAL GtkContainer::set-focus-child ##### -->
<para>
@show_stub:
-<!-- ##### SIGNAL GtkCTree::tree-select-row ##### -->
+<!-- ##### SIGNAL GtkCTree::change-focus-row-expansion ##### -->
<para>
-Emitted when a row is selected.
+The row which has the focus is either collapsed or expanded
+or toggled.
</para>
@ctree: the object which received the signal.
-@node: The node corresponding to the selected row.
-@column: The column which was selected.
+@expansion: What is being done.
-<!-- ##### SIGNAL GtkCTree::tree-unselect-row ##### -->
+<!-- ##### SIGNAL GtkCTree::tree-collapse ##### -->
<para>
-Emitted when a node is unselected.
+Emitted when a node is collapsed.
</para>
@ctree: the object which received the signal.
-@node: The node corresponding to the selected row.
-@column:
+@node:
<!-- ##### SIGNAL GtkCTree::tree-expand ##### -->
<para>
@ctree: the object which received the signal.
@node:
-<!-- ##### SIGNAL GtkCTree::tree-collapse ##### -->
-<para>
-Emitted when a node is collapsed.
-</para>
-
-@ctree: the object which received the signal.
-@node:
-
<!-- ##### SIGNAL GtkCTree::tree-move ##### -->
<para>
Emitted when a node is moved.
@new_parent: The new parent of the node.
@new_sibling: The new sibling of the node.
-<!-- ##### SIGNAL GtkCTree::change-focus-row-expansion ##### -->
+<!-- ##### SIGNAL GtkCTree::tree-select-row ##### -->
<para>
-The row which has the focus is either collapsed or expanded
-or toggled.
+Emitted when a row is selected.
</para>
@ctree: the object which received the signal.
-@expansion: What is being done.
+@node: The node corresponding to the selected row.
+@column: The column which was selected.
+
+<!-- ##### SIGNAL GtkCTree::tree-unselect-row ##### -->
+<para>
+Emitted when a node is unselected.
+</para>
+
+@ctree: the object which received the signal.
+@node: The node corresponding to the selected row.
+@column:
<!-- ##### ARG GtkCTree:n_columns ##### -->
<para>
in the widget.
+<!-- ##### SIGNAL GtkEditable::activate ##### -->
+<para>
+Indicates that the user has activated the widget
+in some fashion. Generally, this will be done
+with a keystroke. (The default binding for this
+action is Return for #GtkEntry and
+Control-Return for #GtkText.)
+</para>
+
+@editable: the object which received the signal.
+
<!-- ##### SIGNAL GtkEditable::changed ##### -->
<para>
Indicates that the user has changed the contents
@editable: the object which received the signal.
-<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
+<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
<para>
-This signal is emitted when text is inserted into
-the widget by the user. The default handler for
-this signal will normally be responsible for inserting
-the text, so by connecting to this signal and then
-stopping the signal with gtk_signal_emit_stop(), it
-is possible to modify the inserted text, or prevent
-it from being inserted entirely.
+An action signal. Causes the characters in the current selection to
+be copied to the clipboard.
+</para>
+
+@editable: the object which received the signal.
+
+<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
+<para>
+An action signal. Causes the characters in the current
+selection to be copied to the clipboard and then deleted from
+the widget.
</para>
@editable: the object which received the signal.
-@new_text: the new text to insert.
-@new_text_length: the length of the new text.
-@position: the position at which to insert the new text.
- this is an in-out paramter. After the signal
- emission is finished, it should point after
- the newly inserted text.
<!-- ##### SIGNAL GtkEditable::delete-text ##### -->
<para>
@start_pos: the starting position.
@end_pos: the end position.
-<!-- ##### SIGNAL GtkEditable::activate ##### -->
+<!-- ##### SIGNAL GtkEditable::insert-text ##### -->
<para>
-Indicates that the user has activated the widget
-in some fashion. Generally, this will be done
-with a keystroke. (The default binding for this
-action is Return for #GtkEntry and
-Control-Return for #GtkText.)
+This signal is emitted when text is inserted into
+the widget by the user. The default handler for
+this signal will normally be responsible for inserting
+the text, so by connecting to this signal and then
+stopping the signal with gtk_signal_emit_stop(), it
+is possible to modify the inserted text, or prevent
+it from being inserted entirely.
</para>
@editable: the object which received the signal.
+@new_text: the new text to insert.
+@new_text_length: the length of the new text.
+@position: the position at which to insert the new text.
+ this is an in-out paramter. After the signal
+ emission is finished, it should point after
+ the newly inserted text.
-<!-- ##### SIGNAL GtkEditable::set-editable ##### -->
+<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
<para>
-Determines if the user can edit the text in the editable
-widget or not. This is meant to be overriden by
-child classes and should not generally useful to
-applications.
+An action signal. Delete a single character.
</para>
@editable: the object which received the signal.
-@is_editable: %TRUE if the user is allowed to edit the text
- in the widget.
+@direction: the direction in which to delete. Positive
+ indicates forward deletion, negative, backwards deletion.
-<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
+<!-- ##### SIGNAL GtkEditable::kill-line ##### -->
<para>
-An action signal. Move the cursor position.
+An action signal. Delete a single line.
</para>
@editable: the object which received the signal.
-@x: horizontal distance to move the cursor.
-@y: vertical distance to move the cursor.
+@direction: the direction in which to delete. Positive
+ indicates forward deletion, negative, backwards deletion.
-<!-- ##### SIGNAL GtkEditable::move-word ##### -->
+<!-- ##### SIGNAL GtkEditable::kill-word ##### -->
<para>
-An action signal. Move the cursor by words.
+An action signal. Delete a single word.
</para>
@editable: the object which received the signal.
-@num_words: The number of words to move the
-cursor. (Can be negative).
+@direction: the direction in which to delete. Positive
+ indicates forward deletion, negative, backwards deletion.
-<!-- ##### SIGNAL GtkEditable::move-page ##### -->
+<!-- ##### SIGNAL GtkEditable::move-cursor ##### -->
<para>
-An action signal. Move the cursor by pages.
+An action signal. Move the cursor position.
</para>
@editable: the object which received the signal.
-@x: Number of pages to move the cursor horizontally.
-@y: Number of pages to move the cursor vertically.
+@x: horizontal distance to move the cursor.
+@y: vertical distance to move the cursor.
-<!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
+<!-- ##### SIGNAL GtkEditable::move-page ##### -->
<para>
-An action signal. Move the cursor to the given row.
+An action signal. Move the cursor by pages.
</para>
@editable: the object which received the signal.
-@row: the row to move to. (A negative value indicates
- the last row)
+@x: Number of pages to move the cursor horizontally.
+@y: Number of pages to move the cursor vertically.
<!-- ##### SIGNAL GtkEditable::move-to-column ##### -->
<para>
@column: the column to move to. (A negative value indicates
the last column)
-<!-- ##### SIGNAL GtkEditable::kill-char ##### -->
-<para>
-An action signal. Delete a single character.
-</para>
-
-@editable: the object which received the signal.
-@direction: the direction in which to delete. Positive
- indicates forward deletion, negative, backwards deletion.
-
-<!-- ##### SIGNAL GtkEditable::kill-word ##### -->
-<para>
-An action signal. Delete a single word.
-</para>
-
-@editable: the object which received the signal.
-@direction: the direction in which to delete. Positive
- indicates forward deletion, negative, backwards deletion.
-
-<!-- ##### SIGNAL GtkEditable::kill-line ##### -->
+<!-- ##### SIGNAL GtkEditable::move-to-row ##### -->
<para>
-An action signal. Delete a single line.
+An action signal. Move the cursor to the given row.
</para>
@editable: the object which received the signal.
-@direction: the direction in which to delete. Positive
- indicates forward deletion, negative, backwards deletion.
+@row: the row to move to. (A negative value indicates
+ the last row)
-<!-- ##### SIGNAL GtkEditable::cut-clipboard ##### -->
+<!-- ##### SIGNAL GtkEditable::move-word ##### -->
<para>
-An action signal. Causes the characters in the current
-selection to be copied to the clipboard and then deleted from
-the widget.
+An action signal. Move the cursor by words.
</para>
@editable: the object which received the signal.
+@num_words: The number of words to move the
+cursor. (Can be negative).
-<!-- ##### SIGNAL GtkEditable::copy-clipboard ##### -->
+<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
<para>
-An action signal. Causes the characters in the current selection to
-be copied to the clipboard.
+An action signal. Causes the contents of the clipboard to
+be pasted into the editable widget at the current cursor
+position.
</para>
@editable: the object which received the signal.
-<!-- ##### SIGNAL GtkEditable::paste-clipboard ##### -->
+<!-- ##### SIGNAL GtkEditable::set-editable ##### -->
<para>
-An action signal. Causes the contents of the clipboard to
-be pasted into the editable widget at the current cursor
-position.
+Determines if the user can edit the text in the editable
+widget or not. This is meant to be overriden by
+child classes and should not generally useful to
+applications.
</para>
@editable: the object which received the signal.
+@is_editable: %TRUE if the user is allowed to edit the text
+ in the widget.
<!-- ##### ARG GtkEditable:text_position ##### -->
<para>
@context:
-<!-- ##### SIGNAL GtkIMContext::preedit-start ##### -->
+<!-- ##### SIGNAL GtkIMContext::commit ##### -->
<para>
</para>
@imcontext: the object which received the signal.
+@arg1:
-<!-- ##### SIGNAL GtkIMContext::preedit-end ##### -->
+<!-- ##### SIGNAL GtkIMContext::preedit-changed ##### -->
<para>
</para>
@imcontext: the object which received the signal.
-<!-- ##### SIGNAL GtkIMContext::preedit-changed ##### -->
+<!-- ##### SIGNAL GtkIMContext::preedit-end ##### -->
<para>
</para>
@imcontext: the object which received the signal.
-<!-- ##### SIGNAL GtkIMContext::commit ##### -->
+<!-- ##### SIGNAL GtkIMContext::preedit-start ##### -->
<para>
</para>
@imcontext: the object which received the signal.
-@arg1:
@Returns: the new #GtkInputDialog.
-<!-- ##### SIGNAL GtkInputDialog::enable-device ##### -->
+<!-- ##### SIGNAL GtkInputDialog::disable-device ##### -->
<para>
This signal is emitted when the user changes the
-mode of a device from #GDK_MODE_DISABLED to a
-#GDK_MODE_SCREEN or #GDK_MODE_WINDOW.
+mode of a device from a #GDK_MODE_SCREEN or #GDK_MODE_WINDOW
+to #GDK_MODE_ENABLED.
</para>
@inputdialog: the object which received the signal.
-@deviceid: The ID of the newly enabled device.
+@deviceid: The ID of the newly disabled device.
-<!-- ##### SIGNAL GtkInputDialog::disable-device ##### -->
+<!-- ##### SIGNAL GtkInputDialog::enable-device ##### -->
<para>
This signal is emitted when the user changes the
-mode of a device from a #GDK_MODE_SCREEN or #GDK_MODE_WINDOW
-to #GDK_MODE_ENABLED.
+mode of a device from #GDK_MODE_DISABLED to a
+#GDK_MODE_SCREEN or #GDK_MODE_WINDOW.
</para>
@inputdialog: the object which received the signal.
-@deviceid: The ID of the newly disabled device.
+@deviceid: The ID of the newly enabled device.
@item: a #GtkItem.
-<!-- ##### SIGNAL GtkItem::select ##### -->
+<!-- ##### SIGNAL GtkItem::deselect ##### -->
<para>
-Emitted when the item is selected.
+Emitted when the item is deselected.
</para>
@item: the object which received the signal.
-<!-- ##### SIGNAL GtkItem::deselect ##### -->
+<!-- ##### SIGNAL GtkItem::select ##### -->
<para>
-Emitted when the item is deselected.
+Emitted when the item is selected.
</para>
@item: the object which received the signal.
@adjustment:
+<!-- ##### SIGNAL GtkLayout::set-scroll-adjustments ##### -->
+<para>
+
+</para>
+
+@layout: the object which received the signal.
+@arg1:
+@arg2:
+
@list: the list widget.
-<!-- ##### SIGNAL GtkList::selection-changed ##### -->
+<!-- ##### SIGNAL GtkList::select-child ##### -->
<para>
-The selection of the widget has just changed.
+The child @widget has just been selected.
</para>
@list: the object which received the signal.
+@widget: the newly selected child.
-<!-- ##### SIGNAL GtkList::select-child ##### -->
+<!-- ##### SIGNAL GtkList::selection-changed ##### -->
<para>
-The child @widget has just been selected.
+The selection of the widget has just changed.
</para>
@list: the object which received the signal.
-@widget: the newly selected child.
<!-- ##### SIGNAL GtkList::unselect-child ##### -->
<para>
@list_item: a #GtkListItem.
-<!-- ##### SIGNAL GtkListItem::toggle-focus-row ##### -->
+<!-- ##### SIGNAL GtkListItem::end-selection ##### -->
<para>
</para>
@listitem: the object which received the signal.
-<!-- ##### SIGNAL GtkListItem::select-all ##### -->
+<!-- ##### SIGNAL GtkListItem::extend-selection ##### -->
<para>
</para>
@listitem: the object which received the signal.
+@scroll_type:
+@position:
+@auto_start_selection:
-<!-- ##### SIGNAL GtkListItem::unselect-all ##### -->
+<!-- ##### SIGNAL GtkListItem::scroll-horizontal ##### -->
<para>
</para>
@listitem: the object which received the signal.
+@scroll_type:
+@position:
-<!-- ##### SIGNAL GtkListItem::undo-selection ##### -->
+<!-- ##### SIGNAL GtkListItem::scroll-vertical ##### -->
<para>
</para>
@listitem: the object which received the signal.
+@scroll_type:
+@position:
-<!-- ##### SIGNAL GtkListItem::start-selection ##### -->
+<!-- ##### SIGNAL GtkListItem::select-all ##### -->
<para>
</para>
@listitem: the object which received the signal.
-<!-- ##### SIGNAL GtkListItem::end-selection ##### -->
+<!-- ##### SIGNAL GtkListItem::start-selection ##### -->
<para>
</para>
@listitem: the object which received the signal.
-<!-- ##### SIGNAL GtkListItem::extend-selection ##### -->
+<!-- ##### SIGNAL GtkListItem::toggle-focus-row ##### -->
<para>
</para>
@listitem: the object which received the signal.
-@scroll_type:
-@position:
-@auto_start_selection:
-<!-- ##### SIGNAL GtkListItem::scroll-vertical ##### -->
+<!-- ##### SIGNAL GtkListItem::undo-selection ##### -->
<para>
</para>
@listitem: the object which received the signal.
-@scroll_type:
-@position:
-<!-- ##### SIGNAL GtkListItem::scroll-horizontal ##### -->
+<!-- ##### SIGNAL GtkListItem::unselect-all ##### -->
<para>
</para>
@listitem: the object which received the signal.
-@scroll_type:
-@position:
+++ /dev/null
-<!-- ##### SECTION Title ##### -->
-Signal Marshallers
-
-<!-- ##### SECTION Short_Description ##### -->
-Functions to adapt C structures to native calling convention.
-
-<!-- ##### SECTION Long_Description ##### -->
-<refsect2>
-<title>What are Signal Marshallers?</title>
-<para>
-Marshals are functions which all have the same prototype:
-they take a #GtkObject, a #GtkSignalFunc, a #gpointer,
-and an array of argument values.
-The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2....
-</para>
-<para>
-They then call a native function: the GtkObject is the first
-parameter passed in. The arguments are passed in the native
-calling convention: chars, shorts, ints, longs may be packed
-on the stack, or tucked in registers: it doesn't matter
-because the same calling convention will be generated
-inside the gtkmarshal code as is expected where you define
-your handlers.
-</para>
-<para>
-So the function named:
-<programlisting>
-gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*);
-</programlisting>
-will call the #GtkSignalFunc assuming it was a function with signature:
-<programlisting>
-gboolean sigfunc(gpointer,gint,gint,guint);
-</programlisting>
-</para>
-</refsect2>
-<refsect2>
-<title>Writing Custom Marshals</title>
-<para>
-Marshals are primarily used as arguments to gtk_signal_new().
-Sometimes, you may find that a marshaller you need isn't available
-in the standard list. Then you have to write your own.
-</para>
-<para>
-If you wish to define a signal with a new type of argument list.
-Suppose you want 2 pointers and 2 integers.
-You would write:
-<programlisting>
-typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)(
- gpointer, gpointer, gint, gint
-);
-
-void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object,
- GtkSignalFunc func,
- gpointer func_data,
- GtkArg* args)
-{
- GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc;
- gint* return_val;
- return_val = GTK_RETLOC_INT(args[4]);
- rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func;
- *return_val = (*rfunc)(object,
- GTK_VALUE_POINTER(args[0]),
- GTK_VALUE_POINTER(args[1]),
- GTK_VALUE_INT(args[2]),
- GTK_VALUE_INT(args[3]),
- func_data);
-}
-</programlisting>
-</para>
-</refsect2>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-<variablelist>
-
-<varlistentry>
-<term>#GtkSignal</term>
-<listitem><para>The signal handling functions (of which marshallers are
-really an implementation detail).</para></listitem>
-</varlistentry>
-
-</variablelist>
-</para>
-
-<!-- ##### MACRO gtk_signal_default_marshaller ##### -->
-<para>
-A marshaller that returns void and takes no extra parameters.
-</para>
-
-
-
+++ /dev/null
-<!-- ##### SECTION Title ##### -->
-Menu Factory
-
-<!-- ##### SECTION Short_Description ##### -->
-
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### USER_FUNCTION GtkMenuCallback ##### -->
-<para>
-
-</para>
-
-@widget:
-@user_data:
-
-
-<!-- ##### STRUCT GtkMenuEntry ##### -->
-<para>
-
-</para>
-
-@path:
-@accelerator:
-@callback:
-@callback_data:
-@widget:
-
-<!-- ##### STRUCT GtkMenuPath ##### -->
-<para>
-
-</para>
-
-@path:
-@widget:
-
-<!-- ##### STRUCT GtkMenuFactory ##### -->
-<para>
-
-</para>
-
-@path:
-@type:
-@accel_group:
-@widget:
-@subfactories:
-
-<!-- ##### FUNCTION gtk_menu_factory_new ##### -->
-<para>
-
-</para>
-
-@type:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_menu_factory_destroy ##### -->
-<para>
-
-</para>
-
-@factory:
-
-
-<!-- ##### FUNCTION gtk_menu_factory_add_entries ##### -->
-<para>
-
-</para>
-
-@factory:
-@entries:
-@nentries:
-
-
-<!-- ##### FUNCTION gtk_menu_factory_add_subfactory ##### -->
-<para>
-
-</para>
-
-@factory:
-@subfactory:
-@path:
-
-
-<!-- ##### FUNCTION gtk_menu_factory_remove_paths ##### -->
-<para>
-
-</para>
-
-@factory:
-@paths:
-@npaths:
-
-
-<!-- ##### FUNCTION gtk_menu_factory_remove_entries ##### -->
-<para>
-
-</para>
-
-@factory:
-@entries:
-@nentries:
-
-
-<!-- ##### FUNCTION gtk_menu_factory_remove_subfactory ##### -->
-<para>
-
-</para>
-
-@factory:
-@subfactory:
-@path:
-
-
-<!-- ##### FUNCTION gtk_menu_factory_find ##### -->
-<para>
-
-</para>
-
-@factory:
-@path:
-@Returns:
-
-
@GTK_MENU_DIR_NEXT:
@GTK_MENU_DIR_PREV:
-<!-- ##### SIGNAL GtkMenuShell::deactivate ##### -->
+<!-- ##### SIGNAL GtkMenuShell::activate-current ##### -->
<para>
-This signal is emitted when a menu shell is deactivated.
+An action signal that activates the current menu item within the menu
+shell.
</para>
@menushell: the object which received the signal.
+@force_hide: if TRUE, hide the menu after activating the menu item.
-<!-- ##### SIGNAL GtkMenuShell::selection-done ##### -->
+<!-- ##### SIGNAL GtkMenuShell::cancel ##### -->
<para>
-This signal is emitted when a selection has been completed within a menu
-shell.
+An action signal which cancels the selection within the menu shell.
+Causes the GtkMenuShell::selection-done signal to be emitted.
</para>
@menushell: the object which received the signal.
-<!-- ##### SIGNAL GtkMenuShell::move-current ##### -->
+<!-- ##### SIGNAL GtkMenuShell::deactivate ##### -->
<para>
-An action signal which moves the current menu item in the direction
-specified by @direction.
+This signal is emitted when a menu shell is deactivated.
</para>
@menushell: the object which received the signal.
-@direction: the direction to move.
-<!-- ##### SIGNAL GtkMenuShell::activate-current ##### -->
+<!-- ##### SIGNAL GtkMenuShell::move-current ##### -->
<para>
-An action signal that activates the current menu item within the menu
-shell.
+An action signal which moves the current menu item in the direction
+specified by @direction.
</para>
@menushell: the object which received the signal.
-@force_hide: if TRUE, hide the menu after activating the menu item.
+@direction: the direction to move.
-<!-- ##### SIGNAL GtkMenuShell::cancel ##### -->
+<!-- ##### SIGNAL GtkMenuShell::selection-done ##### -->
<para>
-An action signal which cancels the selection within the menu shell.
-Causes the GtkMenuShell::selection-done signal to be emitted.
+This signal is emitted when a selection has been completed within a menu
+shell.
</para>
@menushell: the object which received the signal.
ownership of the object.
GTK_CONNECTED: refers to whether are signals are connected to this
object.
-@GTK_CONNECTED:
+@GTK_RESERVED:
@GTK_CONSTRUCTED: refers to whether the arguments for this object are
ready.
</para>
+<!-- # Unused Parameters # -->
@struct:
@field:
-<!-- ##### USER_FUNCTION GtkSignalMarshal ##### -->
-<para>
-This is currently a hack left in for a scheme wrapper library.
-It may be removed.
-</para>
-<para>
-Don't use it.
-</para>
-
-@object: The object which emits the signal.
-@data: The user data associated with the hook.
-@nparams: The number of parameters to the function.
-@args: The actual values of the arguments.
-@arg_types: The types of the arguments.
-@return_type: The type of the return value from the function
-or #GTK_TYPE_NONE for no return value.
-
-
-<!-- ##### USER_FUNCTION GtkSignalDestroy ##### -->
-<para>
-A function which you can use to clean up when the
-signal handler is destroyed.
-</para>
-<para>
-For example, if your handler requires a few variables
-that you made into a struct and allocated (using g_new()
-or something), then you will probably want to free
-it as soon as the hook is destroyed. This will
-allow you to do that. (For this in particular
-it is convenient to pass g_free() as a #GtkSignalDestroy
-function).
-</para>
-
-@data: The user data associated with the hook that is being
-destroyed.
-
-
-<!-- ##### USER_FUNCTION GtkEmissionHook ##### -->
+<!-- ##### TYPEDEF GtkEmissionHook ##### -->
<para>
A simple function pointer to get invoked when the
signal is emitted. This allows you tie a hook to the signal type,
#GTK_RUN_NO_HOOKS flag.
</para>
-@object: the object which emits the signal.
-@signal_id: the unique integer identify the signal type.
-@n_params: the number of parameters to the function,
-not including return value.
-@params: the parameters to the function. A pointer to
-the return value is passed as a last element.
-@data: the user data associated with the hook.
-@Returns: whether it wished to be removed. If it returns
-TRUE, the signal hook is disconnected (and destroyed).
-
-
-<!-- ##### STRUCT GtkSignalQuery ##### -->
-<para>
-This structure contains all the information about a particular
-signal: its name, the type it affects, the signature of the handlers,
-and its unique identifying integer.
-</para>
-
-@object_type:
-@signal_id:
-@signal_name:
-@is_user_signal:
-@signal_flags:
-@return_val:
-@nparams:
-@params:
<!-- ##### ENUM GtkSignalRunType ##### -->
<para>
@GTK_RUN_ACTION:
@GTK_RUN_NO_HOOKS:
-<!-- ##### FUNCTION gtk_signal_init ##### -->
+<!-- ##### MACRO gtk_signal_init ##### -->
<para>
</para>
which takes a string and returns a boolean value.
@return_val: the type of return value, or GTK_TYPE_NONE for a signal
without a return value.
-@nparams: the number of parameter the handlers may take.
+@n_args:
@Varargs: a list of GTK_TYPE_*, one for each parameter.
@Returns: the signal id.
+<!-- # Unused Parameters # -->
+@nparams: the number of parameter the handlers may take.
<!-- ##### FUNCTION gtk_signal_newv ##### -->
@marshaller:
@return_val: the type of the return value, or GTK_TYPE_NONE if
you don't want a return value.
+@n_args:
+@args:
+@Returns: the signal id.
+<!-- # Unused Parameters # -->
@nparams: the number of parameters to the user-defined handlers.
@params: an array of GtkTypes, describing the prototype to
the callbacks.
-@Returns: the signal id.
-<!-- ##### FUNCTION gtk_signal_lookup ##### -->
+<!-- ##### MACRO gtk_signal_lookup ##### -->
<para>
Given the name of the signal and the type of object it connects
to, get the signal's identifying integer. Emitting the signal
It also tries the ancestors of the given type.
</para>
+@Returns: the signal's identifying number, or 0 if no signal was found.
+<!-- # Unused Parameters # -->
@name: the signal's name, e.g. clicked.
@object_type: the type that the signal operates on, e.g. #GTK_TYPE_BUTTON.
-@Returns: the signal's identifying number, or 0 if no signal was found.
-<!-- ##### FUNCTION gtk_signal_name ##### -->
+<!-- ##### MACRO gtk_signal_name ##### -->
<para>
Given the signal's identifier, find its name.
</para>
Two different signals may have the same name, if they have differing types.
</para>
-@signal_id: the signal's identifying number.
@Returns: the signal name, or NULL if the signal number was invalid.
+<!-- # Unused Parameters # -->
+@signal_id: the signal's identifying number.
<!-- ##### FUNCTION gtk_signal_emit ##### -->
@object: the object to emit the signal to.
@signal_id: the signal identifier.
+@args:
+<!-- # Unused Parameters # -->
@params: an array of GtkArgs, one for each parameter,
followed by one which is a pointer to the return type.
@object: the object to emit the signal to.
@name: the name of the signal.
+@args:
+<!-- # Unused Parameters # -->
@params: an array of GtkArgs, one for each parameter,
followed by one which is a pointer to the return type.
-<!-- ##### FUNCTION gtk_signal_n_emissions ##### -->
-<para>
-Find out the recursion depth of emissions for a particular type
-of signal and object. (So it will
-always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified)
-This is a way to avoid recursion: you can see if
-you are currently running in that signal handler and emit it only
-if you are.
-</para>
-<para>Another way to look at it is that this number increases
-by one when #gtk_signal_emit(), et al, are called,
-and decreases by one when #gtk_signal_emit() returns.
-</para>
-
-@object: the object with the signal handler.
-@signal_id: the signal id.
-@Returns: the recursion depth of emissions of this signal for this
-object.
-
-
-<!-- ##### FUNCTION gtk_signal_n_emissions_by_name ##### -->
-<para>
-Find out the recursion depth of emissions for a particular type
-of signal and object. Just like gtk_signal_n_emissions()
-except it will lookup the signal id for you.
-</para>
-
-@object: the object with the signal handler.
-@name: the signal name.
-@Returns: the recursion depth of emissions of this signal for this
-object.
-
-
-<!-- ##### FUNCTION gtk_signal_emit_stop ##### -->
+<!-- ##### MACRO gtk_signal_emit_stop ##### -->
<para>
This function aborts a signal's current emission.
</para>
isn't being emitted.
</para>
+@i:
+@s:
+<!-- # Unused Parameters # -->
@object: the object whose signal handlers you wish to stop.
@signal_id: the signal identifier, as returned by gtk_signal_lookup().
@name: the name of the signal you wish to stop.
-<!-- ##### FUNCTION gtk_signal_connect ##### -->
+<!-- ##### MACRO gtk_signal_connect ##### -->
<para>
Attach a function pointer and user data to a signal for
a particular object.
</programlisting>
</informalexample>
+@o:
+@s:
+@f:
+@d:
+@Returns: the connection id.
+<!-- # Unused Parameters # -->
@object: the object associated with the signal, e.g. if a button
is getting pressed, this is that button.
@name: name of the signal.
@func: function pointer to attach to the signal.
@func_data: value to pass as to your function (through the marshaller).
-@Returns: the connection id.
-<!-- ##### FUNCTION gtk_signal_connect_after ##### -->
+<!-- ##### MACRO gtk_signal_connect_after ##### -->
<para>
Attach a function pointer and user data to a signal
so that this handler will be called after the other handlers.
</para>
+@o:
+@s:
+@f:
+@d:
+@Returns: the unique identifier for this attachment: the connection id.
+<!-- # Unused Parameters # -->
@object: the object associated with the signal.
@name: name of the signal.
@func: function pointer to attach to the signal.
@func_data: value to pass as to your function (through the marshaller).
-@Returns: the unique identifier for this attachment: the connection id.
-<!-- ##### FUNCTION gtk_signal_connect_object ##### -->
+<!-- ##### MACRO gtk_signal_connect_object ##### -->
<para>
This function is for registering a callback that will
call another object's callback. That is,
</programlisting>
</informalexample>
+@o:
+@s:
+@f:
+@d:
+@Returns: the connection id.
+<!-- # Unused Parameters # -->
@object: the object which emits the signal.
@name: the name of the signal.
@func: the function to callback.
@slot_object: the object to pass as the first parameter to func.
(Though it pretends to take an object, you can
really pass any gpointer as the #slot_object .)
-@Returns: the connection id.
-<!-- ##### FUNCTION gtk_signal_connect_object_after ##### -->
+<!-- ##### MACRO gtk_signal_connect_object_after ##### -->
<para>
Attach a signal hook to a signal, passing in an alternate
object as the first parameter, and guaranteeing
handlers are called first.
</para>
+@o:
+@s:
+@f:
+@d:
+@Returns: the connection id.
+<!-- # Unused Parameters # -->
@object: the object associated with the signal.
@name: name of the signal.
@func: function pointer to attach to the signal.
@slot_object: the object to pass as the first parameter to #func.
-@Returns: the connection id.
<!-- ##### FUNCTION gtk_signal_connect_full ##### -->
in the button press signal.
@name: the name of the signal.
@func: function pointer to attach to the signal.
-@marshal: the function marshal, see the gtkmarshall documentation for
-more details, but briefly: the marshaller is a function which takes
-the #GtkObject which emits the signal, the user data, the number of the
-arguments, and the array of arguments. It is responsible for
-calling the function in the appropriate calling convention.
-gtk_signal_default_marshaller is usually fine.
-(This shows up, for example, when worrying about matching
-c++ or other languages' calling conventions.)
+@unsupported:
@data: the user data associated with the function.
@destroy_func: function to call when this particular hook is
disconnected.
the signal's default behavior preside (i.e. depending on #GTK_RUN_FIRST
and #GTK_RUN_LAST).
@Returns: the connection id.
+<!-- # Unused Parameters # -->
+@marshal: the function marshal, see the gtkmarshall documentation for
+more details, but briefly: the marshaller is a function which takes
+the #GtkObject which emits the signal, the user data, the number of the
+arguments, and the array of arguments. It is responsible for
+calling the function in the appropriate calling convention.
+gtk_signal_default_marshaller is usually fine.
+(This shows up, for example, when worrying about matching
+c++ or other languages' calling conventions.)
<!-- ##### FUNCTION gtk_signal_connect_while_alive ##### -->
@name: name of the signal.
-<!-- ##### FUNCTION gtk_signal_disconnect ##### -->
+<!-- ##### MACRO gtk_signal_disconnect ##### -->
<para>
Destroy a user-defined handler connection.
</para>
+<!-- # Unused Parameters # -->
@object: the object which the handler pertains to.
@handler_id: the connection id.
-<!-- ##### FUNCTION gtk_signal_disconnect_by_func ##### -->
+<!-- ##### MACRO gtk_signal_disconnect_by_func ##### -->
<para>
Destroy all connections for a particular object, with
the given function-pointer and user-data.
</para>
+@o:
+@f:
+@d:
+<!-- # Unused Parameters # -->
@object: the object which emits the signal.
@func: the function pointer to search for.
@data: the user data to search for.
-<!-- ##### FUNCTION gtk_signal_disconnect_by_data ##### -->
+<!-- ##### MACRO gtk_signal_disconnect_by_data ##### -->
<para>
Destroy all connections for a particular object, with
the given user-data.
</para>
+@o:
+@d:
+<!-- # Unused Parameters # -->
@object: the object which emits the signal.
@data: the user data to search for.
-<!-- ##### FUNCTION gtk_signal_handler_block ##### -->
+<!-- ##### MACRO gtk_signal_handler_block ##### -->
<para>
Prevent an user-defined handler from being invoked. All other
signal processing will go on as normal, but this particular
handler will ignore it.
</para>
+<!-- # Unused Parameters # -->
@object: the object which emits the signal to block.
@handler_id: the connection id.
-<!-- ##### FUNCTION gtk_signal_handler_block_by_func ##### -->
+<!-- ##### MACRO gtk_signal_handler_block_by_func ##### -->
<para>
Prevent a user-defined handler from being invoked, by reference to
the user-defined handler's function pointer and user data. (It may result in
multiple hooks being blocked, if you've called connect multiple times.)
</para>
+@o:
+@f:
+@d:
+<!-- # Unused Parameters # -->
@object: the object which emits the signal to block.
@func: the function pointer of the handler to block.
@data: the user data of the handler to block.
-<!-- ##### FUNCTION gtk_signal_handler_block_by_data ##### -->
+<!-- ##### MACRO gtk_signal_handler_block_by_data ##### -->
<para>
Prevent all user-defined handlers with a certain user data from being invoked.
</para>
+@o:
+@d:
+<!-- # Unused Parameters # -->
@object: the object which emits the signal we want to block.
@data: the user data of the handlers to block.
-<!-- ##### FUNCTION gtk_signal_handler_unblock ##### -->
+<!-- ##### MACRO gtk_signal_handler_unblock ##### -->
<para>
Undo a block, by connection id. Note that undoing a block doesn't
necessarily make the hook callable, because if you block a
hook twice, you must unblock it twice.
</para>
+<!-- # Unused Parameters # -->
@object: the object which emits the signal we want to unblock.
@handler_id: the emission handler identifier, as returned by
gtk_signal_connect(), etc.
-<!-- ##### FUNCTION gtk_signal_handler_unblock_by_func ##### -->
+<!-- ##### MACRO gtk_signal_handler_unblock_by_func ##### -->
<para>
Undo a block, by function pointer and data.
Note that undoing a block doesn't
hook twice, you must unblock it twice.
</para>
+@o:
+@f:
+@d:
+<!-- # Unused Parameters # -->
@object: the object which emits the signal we want to unblock.
@func: the function pointer to search for.
@data: the user data to search for.
-<!-- ##### FUNCTION gtk_signal_handler_unblock_by_data ##### -->
+<!-- ##### MACRO gtk_signal_handler_unblock_by_data ##### -->
<para>
Undo block(s), to all signals for a particular object
with a particular user-data pointer
</para>
+@o:
+@d:
+<!-- # Unused Parameters # -->
@object: the object which emits the signal we want to unblock.
@data: the user data to search for.
-<!-- ##### FUNCTION gtk_signal_handler_pending ##### -->
+<!-- ##### MACRO gtk_signal_handler_pending ##### -->
<para>
Returns a connection id corresponding to a given signal id and object.
</para>
thus saving the cost of building the arguments.
</para>
+@i:
+@s:
+@b:
+@Returns: the connection id, if a connection was found. 0 otherwise.
+<!-- # Unused Parameters # -->
@object: the object to search for the desired user-defined handler.
@signal_id: the number of the signal to search for.
@may_be_blocked: whether it is acceptable to return a blocked
handler.
-@Returns: the connection id, if a connection was found. 0 otherwise.
-<!-- ##### FUNCTION gtk_signal_handler_pending_by_func ##### -->
+<!-- ##### MACRO gtk_signal_handler_pending_by_func ##### -->
<para>
Returns a connection id corresponding to a given signal id, object, function
pointer and user data.
</para>
+@o:
+@s:
+@b:
+@f:
+@d:
+@Returns: the connection id, if a handler was found. 0 otherwise.
+<!-- # Unused Parameters # -->
@object: the object to search for the desired handler.
@signal_id: the number of the signal to search for.
@may_be_blocked: whether it is acceptable to return a blocked
handler.
@func: the function pointer to search for.
@data: the user data to search for.
-@Returns: the connection id, if a handler was found. 0 otherwise.
-<!-- ##### FUNCTION gtk_signal_handler_pending_by_id ##### -->
-<para>
-Returns whether a connection id is valid (and optionally not blocked).
-</para>
-
-@object: the object to search for the desired handler.
-@handler_id: the connection id.
-@may_be_blocked: whether it is acceptable to return a blocked
-handler.
-@Returns: TRUE if the signal exists and wasn't blocked,
-unless #may_be_blocked was specified. FALSE otherwise.
-
-
-<!-- ##### FUNCTION gtk_signal_handlers_destroy ##### -->
-<para>
-Destroy all the signal handlers connected to an object.
-This is done automatically when the object is destroyed.
-</para>
-<para>
-This function is labeled private.
-</para>
-
-@object: the object whose signal handlers should be destroyed.
-
-
-<!-- ##### FUNCTION gtk_signal_set_funcs ##### -->
-<para>
-These set default functions to call when the user didn't
-supply a function when connecting. (These are rarely
-used, and probably only for language bindings)
-</para>
-<para>
-By default, there are no such functions.
-</para>
-
-@marshal_func: the function to invoke on every handlers for which there
-isn't a function pointer. May be NULL.
-@destroy_func: the function to invoke when each hook is destroyed.
-May be NULL.
-
-
-<!-- ##### FUNCTION gtk_signal_query ##### -->
-<para>
-Obtain information about a signal.
-</para>
-
-@signal_id: the signal type identifier.
-@Returns: a pointer to a GtkSignalQuery structure
-which contains all the information, or NULL.
-The pointer is allocated just for you: you must g_free() it.
-
-
-<!-- ##### FUNCTION gtk_signal_add_emission_hook ##### -->
+<!-- ##### MACRO gtk_signal_add_emission_hook ##### -->
<para>
Add an emission hook for a type of signal, for any object.
</para>
-@signal_id: the type of signal to hook for.
-@hook_func: the function to invoke to handle the emission hook.
-@data: the user data passed in to hook_func.
+@i:
+@h:
+@d:
@Returns: the id (that you may pass as a parameter
to gtk_signal_remove_emission_hook()).
-
-
-<!-- ##### FUNCTION gtk_signal_add_emission_hook_full ##### -->
-<para>
-Add an emission hook for a type of signal, for any object.
-(with control of what happens when the hook is
-destroyed).
-</para>
-
-@signal_id: the type of signal add the hook for.
-@hook_func: the function to invoke to handle the hook.
+<!-- # Unused Parameters # -->
+@signal_id: the type of signal to hook for.
+@hook_func: the function to invoke to handle the emission hook.
@data: the user data passed in to hook_func.
-@destroy: a function to invoke when the hook is destroyed,
-to clean up any allocation done just for this
-signal handler.
-@Returns: the id (that you may pass as a parameter
-to gtk_signal_remove_emission_hook()).
-<!-- ##### FUNCTION gtk_signal_remove_emission_hook ##### -->
+<!-- ##### MACRO gtk_signal_remove_emission_hook ##### -->
<para>
Delete an emission hook. (see gtk_signal_add_emission_hook())
</para>
+@i:
+@h:
+<!-- # Unused Parameters # -->
@signal_id: the id of the signal type.
@hook_id: the id of the emission handler, returned by add_emission_hook().
@message_id: a message identifier, as returned by gtk_statusbar_push().
-<!-- ##### SIGNAL GtkStatusbar::text-pushed ##### -->
+<!-- ##### SIGNAL GtkStatusbar::text-popped ##### -->
<para>
-Is emitted whenever a new message gets pushed onto a statusbar's stack.
+Is emitted whenever a new message is popped off a statusbar's stack.
</para>
@statusbar: the object which received the signal.
@context_id: the context id of the relevant message/statusbar.
-@text: the message that was pushed.
+@text: the message that was just popped.
-<!-- ##### SIGNAL GtkStatusbar::text-popped ##### -->
+<!-- ##### SIGNAL GtkStatusbar::text-pushed ##### -->
<para>
-Is emitted whenever a new message is popped off a statusbar's stack.
+Is emitted whenever a new message gets pushed onto a statusbar's stack.
</para>
@statusbar: the object which received the signal.
@context_id: the context id of the relevant message/statusbar.
-@text: the message that was just popped.
+@text: the message that was pushed.
@index: the number of characters from the upper left corner
+<!-- ##### SIGNAL GtkText::set-scroll-adjustments ##### -->
+<para>
+
+</para>
+
+@text: the object which received the signal.
+@arg1:
+@arg2:
+
<!-- ##### ARG GtkText:hadjustment ##### -->
<para>\r
Used by the #GtkText widget to keep track of the size of it's horizontal\r
#GtkTextView, #GtkTextIter, #GtkTextMark
</para>
-<!-- ##### STRUCT GtkTextBTree ##### -->
-<para>
-
-</para>
-
-
<!-- ##### FUNCTION gtk_text_buffer_new ##### -->
<para>
@Returns:
-<!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
+<!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
<para>
</para>
@arg1:
@arg2:
@arg3:
-@arg4:
-<!-- ##### SIGNAL GtkTextBuffer::delete-text ##### -->
+<!-- ##### SIGNAL GtkTextBuffer::changed ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
-@arg1:
-@arg2:
-@arg3:
-<!-- ##### SIGNAL GtkTextBuffer::changed ##### -->
+<!-- ##### SIGNAL GtkTextBuffer::delete-text ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
+@arg1:
+@arg2:
+@arg3:
-<!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
+<!-- ##### SIGNAL GtkTextBuffer::insert-text ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
+@arg1:
+@arg2:
+@arg3:
+@arg4:
-<!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
+<!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
@arg1:
-@arg2:
-<!-- ##### SIGNAL GtkTextBuffer::mark-deleted ##### -->
+<!-- ##### SIGNAL GtkTextBuffer::mark-set ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
@arg1:
+@arg2:
-<!-- ##### SIGNAL GtkTextBuffer::apply-tag ##### -->
+<!-- ##### SIGNAL GtkTextBuffer::modified-changed ##### -->
<para>
</para>
@textbuffer: the object which received the signal.
-@arg1:
-@arg2:
-@arg3:
<!-- ##### SIGNAL GtkTextBuffer::remove-tag ##### -->
<para>
@str:
@visible_only:
@slice:
+@match_start:
+@match_end:
@Returns:
</para>
+@parent_instance:
+@segment:
<!-- ##### FUNCTION gtk_text_mark_set_visible ##### -->
<para>
@Returns:
-<!-- ##### FUNCTION gtk_text_mark_ref ##### -->
-<para>
-
-</para>
-
-@mark:
-@Returns:
-
-
-<!-- ##### FUNCTION gtk_text_mark_unref ##### -->
-<para>
-
-</para>
-
-@mark:
-
-
<!-- ##### FUNCTION gtk_text_mark_get_deleted ##### -->
<para>
@refcount:
@appearance:
-@relief:
@justify:
@direction:
@font_desc:
@Returns:
-<!-- ##### SIGNAL GtkTextTagTable::tag-changed ##### -->
+<!-- ##### SIGNAL GtkTextTagTable::tag-added ##### -->
<para>
</para>
@texttagtable: the object which received the signal.
@arg1:
-@arg2:
-<!-- ##### SIGNAL GtkTextTagTable::tag-added ##### -->
+<!-- ##### SIGNAL GtkTextTagTable::tag-changed ##### -->
<para>
</para>
@texttagtable: the object which received the signal.
@arg1:
+@arg2:
<!-- ##### SIGNAL GtkTextTagTable::tag-removed ##### -->
<para>
@location:
-<!-- ##### SIGNAL GtkTextView::move ##### -->
+<!-- ##### SIGNAL GtkTextView::copy-clipboard ##### -->
<para>
</para>
@textview: the object which received the signal.
-@arg1:
-@arg2:
-@arg3:
-<!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
+<!-- ##### SIGNAL GtkTextView::cut-clipboard ##### -->
<para>
</para>
@textview: the object which received the signal.
-<!-- ##### SIGNAL GtkTextView::insert ##### -->
+<!-- ##### SIGNAL GtkTextView::delete ##### -->
<para>
</para>
@textview: the object which received the signal.
@arg1:
+@arg2:
-<!-- ##### SIGNAL GtkTextView::delete ##### -->
+<!-- ##### SIGNAL GtkTextView::insert ##### -->
<para>
</para>
@textview: the object which received the signal.
@arg1:
-@arg2:
-<!-- ##### SIGNAL GtkTextView::cut-clipboard ##### -->
+<!-- ##### SIGNAL GtkTextView::move ##### -->
<para>
</para>
@textview: the object which received the signal.
+@arg1:
+@arg2:
+@arg3:
-<!-- ##### SIGNAL GtkTextView::copy-clipboard ##### -->
+<!-- ##### SIGNAL GtkTextView::paste-clipboard ##### -->
<para>
</para>
@textview: the object which received the signal.
-<!-- ##### SIGNAL GtkTextView::paste-clipboard ##### -->
+<!-- ##### SIGNAL GtkTextView::set-anchor ##### -->
<para>
</para>
@textview: the object which received the signal.
-<!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
+<!-- ##### SIGNAL GtkTextView::set-scroll-adjustments ##### -->
<para>
</para>
@textview: the object which received the signal.
+@arg1:
+@arg2:
-<!-- ##### SIGNAL GtkTextView::set-scroll-adjustments ##### -->
+<!-- ##### SIGNAL GtkTextView::toggle-overwrite ##### -->
<para>
</para>
@textview: the object which received the signal.
-@arg1:
-@arg2:
<!-- ##### ARG GtkTextView:height_lines ##### -->
<para>
@child: A pointer to the #GtkWidget that is to be removed from the tree.
-<!-- ##### SIGNAL GtkTree::selection-changed ##### -->
+<!-- ##### SIGNAL GtkTree::select-child ##### -->
<para>
-This signal is emitted by the root tree whenever the selection changes.
+This signal is emitted by @tree whenever @widget is about to be selected.
</para>
@tree: the object which received the signal.
+@widget: The child that is about to be selected.
-<!-- ##### SIGNAL GtkTree::select-child ##### -->
+<!-- ##### SIGNAL GtkTree::selection-changed ##### -->
<para>
-This signal is emitted by @tree whenever @widget is about to be selected.
+This signal is emitted by the root tree whenever the selection changes.
</para>
@tree: the object which received the signal.
-@widget: The child that is about to be selected.
<!-- ##### SIGNAL GtkTree::unselect-child ##### -->
<para>
@args: GtkArg*
-<!-- ##### USER_FUNCTION GtkSignalMarshaller ##### -->
+<!-- ##### TYPEDEF GtkSignalMarshaller ##### -->
<para>
Define a function pointer.
</para>
-@object: GtkObject*
-@func: GtkSignalFunc
-@func_data: gpointer
-@args: GtkArg*
-
<!-- ##### USER_FUNCTION GtkArgGetFunc ##### -->
<para>
@type:
+<!-- ##### SIGNAL GtkViewport::set-scroll-adjustments ##### -->
+<para>
+
+</para>
+
+@viewport: the object which received the signal.
+@arg1:
+@arg2:
+
<!-- ##### ARG GtkViewport:hadjustment ##### -->
<para>
@Returns:
-<!-- ##### SIGNAL GtkWidget::show ##### -->
+<!-- ##### SIGNAL GtkWidget::add-accelerator ##### -->
<para>
</para>
@widget: the object which received the signal.
+@accel_signal_id:
+@accel_group:
+@accel_key:
+@accel_mods:
+@accel_flags:
-<!-- ##### SIGNAL GtkWidget::hide ##### -->
+<!-- ##### SIGNAL GtkWidget::button-press-event ##### -->
<para>
</para>
@widget: the object which received the signal.
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::map ##### -->
+<!-- ##### SIGNAL GtkWidget::button-release-event ##### -->
<para>
</para>
@widget: the object which received the signal.
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::unmap ##### -->
+<!-- ##### SIGNAL GtkWidget::client-event ##### -->
<para>
</para>
@widget: the object which received the signal.
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::realize ##### -->
+<!-- ##### SIGNAL GtkWidget::configure-event ##### -->
<para>
</para>
@widget: the object which received the signal.
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::unrealize ##### -->
+<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
<para>
</para>
@widget: the object which received the signal.
+@message:
-<!-- ##### SIGNAL GtkWidget::draw ##### -->
+<!-- ##### SIGNAL GtkWidget::delete-event ##### -->
<para>
</para>
@widget: the object which received the signal.
-@area:
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
+<!-- ##### SIGNAL GtkWidget::destroy-event ##### -->
<para>
</para>
@widget: the object which received the signal.
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
+<!-- ##### SIGNAL GtkWidget::direction-changed ##### -->
<para>
</para>
@widget: the object which received the signal.
+@arg1:
-<!-- ##### SIGNAL GtkWidget::size-request ##### -->
+<!-- ##### SIGNAL GtkWidget::drag-begin ##### -->
<para>
</para>
@widget: the object which received the signal.
-@requisition:
+@drag_context:
-<!-- ##### SIGNAL GtkWidget::size-allocate ##### -->
+<!-- ##### SIGNAL GtkWidget::drag-data-delete ##### -->
<para>
</para>
@widget: the object which received the signal.
-@allocation:
+@drag_context:
-<!-- ##### SIGNAL GtkWidget::state-changed ##### -->
+<!-- ##### SIGNAL GtkWidget::drag-data-get ##### -->
<para>
</para>
@widget: the object which received the signal.
-@state:
+@drag_context:
+@data:
+@info:
+@time:
-<!-- ##### SIGNAL GtkWidget::parent-set ##### -->
+<!-- ##### SIGNAL GtkWidget::drag-data-received ##### -->
<para>
</para>
@widget: the object which received the signal.
-@old_parent:
+@drag_context:
+@x:
+@y:
+@data:
+@info:
+@time:
-<!-- ##### SIGNAL GtkWidget::style-set ##### -->
+<!-- ##### SIGNAL GtkWidget::drag-drop ##### -->
<para>
</para>
@widget: the object which received the signal.
-@previous_style:
+@drag_context:
+@x:
+@y:
+@time:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::direction-changed ##### -->
+<!-- ##### SIGNAL GtkWidget::drag-end ##### -->
<para>
</para>
@widget: the object which received the signal.
-@arg1:
+@drag_context:
-<!-- ##### SIGNAL GtkWidget::add-accelerator ##### -->
+<!-- ##### SIGNAL GtkWidget::drag-leave ##### -->
<para>
</para>
@widget: the object which received the signal.
-@accel_signal_id:
-@accel_group:
-@accel_key:
-@accel_mods:
-@accel_flags:
+@drag_context:
+@time:
-<!-- ##### SIGNAL GtkWidget::remove-accelerator ##### -->
+<!-- ##### SIGNAL GtkWidget::drag-motion ##### -->
<para>
</para>
@widget: the object which received the signal.
-@accel_group:
-@accel_key:
-@accel_mods:
+@drag_context:
+@x:
+@y:
+@time:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::grab-focus ##### -->
+<!-- ##### SIGNAL GtkWidget::draw ##### -->
<para>
</para>
@widget: the object which received the signal.
+@area:
-<!-- ##### SIGNAL GtkWidget::event ##### -->
+<!-- ##### SIGNAL GtkWidget::draw-default ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
-<!-- ##### SIGNAL GtkWidget::button-press-event ##### -->
+<!-- ##### SIGNAL GtkWidget::draw-focus ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
-<!-- ##### SIGNAL GtkWidget::button-release-event ##### -->
+<!-- ##### SIGNAL GtkWidget::enter-notify-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::scroll-event ##### -->
+<!-- ##### SIGNAL GtkWidget::event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::motion-notify-event ##### -->
+<!-- ##### SIGNAL GtkWidget::expose-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::delete-event ##### -->
+<!-- ##### SIGNAL GtkWidget::focus-in-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::destroy-event ##### -->
+<!-- ##### SIGNAL GtkWidget::focus-out-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::expose-event ##### -->
+<!-- ##### SIGNAL GtkWidget::grab-focus ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
-<!-- ##### SIGNAL GtkWidget::key-press-event ##### -->
+<!-- ##### SIGNAL GtkWidget::hide ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
-<!-- ##### SIGNAL GtkWidget::key-release-event ##### -->
+<!-- ##### SIGNAL GtkWidget::key-press-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::enter-notify-event ##### -->
+<!-- ##### SIGNAL GtkWidget::key-release-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::configure-event ##### -->
+<!-- ##### SIGNAL GtkWidget::map ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
-<!-- ##### SIGNAL GtkWidget::focus-in-event ##### -->
+<!-- ##### SIGNAL GtkWidget::map-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::focus-out-event ##### -->
+<!-- ##### SIGNAL GtkWidget::motion-notify-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::map-event ##### -->
+<!-- ##### SIGNAL GtkWidget::no-expose-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::unmap-event ##### -->
+<!-- ##### SIGNAL GtkWidget::parent-set ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
+@old_parent:
<!-- ##### SIGNAL GtkWidget::property-notify-event ##### -->
<para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::selection-clear-event ##### -->
+<!-- ##### SIGNAL GtkWidget::proximity-in-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::selection-request-event ##### -->
+<!-- ##### SIGNAL GtkWidget::proximity-out-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::selection-notify-event ##### -->
+<!-- ##### SIGNAL GtkWidget::realize ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
-<!-- ##### SIGNAL GtkWidget::selection-get ##### -->
+<!-- ##### SIGNAL GtkWidget::remove-accelerator ##### -->
<para>
</para>
@widget: the object which received the signal.
-@data:
-@info:
-@time:
+@accel_group:
+@accel_key:
+@accel_mods:
-<!-- ##### SIGNAL GtkWidget::selection-received ##### -->
+<!-- ##### SIGNAL GtkWidget::scroll-event ##### -->
<para>
</para>
@widget: the object which received the signal.
-@data:
-@time:
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::proximity-in-event ##### -->
+<!-- ##### SIGNAL GtkWidget::selection-clear-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::proximity-out-event ##### -->
+<!-- ##### SIGNAL GtkWidget::selection-get ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
+@data:
+@info:
+@time:
-<!-- ##### SIGNAL GtkWidget::drag-begin ##### -->
+<!-- ##### SIGNAL GtkWidget::selection-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
-@drag_context:
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::drag-end ##### -->
+<!-- ##### SIGNAL GtkWidget::selection-received ##### -->
<para>
</para>
@widget: the object which received the signal.
-@drag_context:
+@data:
+@time:
-<!-- ##### SIGNAL GtkWidget::drag-data-delete ##### -->
+<!-- ##### SIGNAL GtkWidget::selection-request-event ##### -->
<para>
</para>
@widget: the object which received the signal.
-@drag_context:
+@event:
+@Returns:
-<!-- ##### SIGNAL GtkWidget::drag-leave ##### -->
+<!-- ##### SIGNAL GtkWidget::show ##### -->
<para>
</para>
@widget: the object which received the signal.
-@drag_context:
-@time:
-<!-- ##### SIGNAL GtkWidget::drag-motion ##### -->
+<!-- ##### SIGNAL GtkWidget::size-allocate ##### -->
<para>
</para>
@widget: the object which received the signal.
-@drag_context:
-@x:
-@y:
-@time:
-@Returns:
+@allocation:
-<!-- ##### SIGNAL GtkWidget::drag-drop ##### -->
+<!-- ##### SIGNAL GtkWidget::size-request ##### -->
<para>
</para>
@widget: the object which received the signal.
-@drag_context:
-@x:
-@y:
-@time:
-@Returns:
+@requisition:
-<!-- ##### SIGNAL GtkWidget::drag-data-get ##### -->
+<!-- ##### SIGNAL GtkWidget::state-changed ##### -->
<para>
</para>
@widget: the object which received the signal.
-@drag_context:
-@data:
-@info:
-@time:
+@state:
-<!-- ##### SIGNAL GtkWidget::drag-data-received ##### -->
+<!-- ##### SIGNAL GtkWidget::style-set ##### -->
<para>
</para>
@widget: the object which received the signal.
-@drag_context:
-@x:
-@y:
-@data:
-@info:
-@time:
+@previous_style:
-<!-- ##### SIGNAL GtkWidget::client-event ##### -->
+<!-- ##### SIGNAL GtkWidget::unmap ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
-<!-- ##### SIGNAL GtkWidget::no-expose-event ##### -->
+<!-- ##### SIGNAL GtkWidget::unmap-event ##### -->
<para>
</para>
@event:
@Returns:
-<!-- ##### SIGNAL GtkWidget::visibility-notify-event ##### -->
+<!-- ##### SIGNAL GtkWidget::unrealize ##### -->
<para>
</para>
@widget: the object which received the signal.
-@event:
-@Returns:
-<!-- ##### SIGNAL GtkWidget::debug-msg ##### -->
+<!-- ##### SIGNAL GtkWidget::visibility-notify-event ##### -->
<para>
</para>
@widget: the object which received the signal.
-@message:
+@event:
+@Returns:
<!-- ##### ARG GtkWidget:name ##### -->
<para>
projects / gtk4.git / commitdiff